Mercurial > hg > orthanc-book

annotate Sphinx/source/contributing.rst @ 213:f40f7d15e6bb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated configuration file section
author amazy
date Fri, 22 Feb 2019 10:30:49 +0100
parents 76c76af97a2a
children ba6b6e4ba14b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
diff changeset
1 .. _contributing:
25fa874803ab plugins inside book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 20
diff changeset
2
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 Contributing to Orthanc
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 =======================
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 If you find Orthanc useful and wish to contribute to its development,
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 here are some tasks you can take in charge that would greatly help us:
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
9 * **Non-coding tasks**:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
10
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
11 - Use Orthanc in the real life. ;)
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
12 - Advertise about Orthanc, notably on social networks (we are active
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
13 on `Facebook <https://www.facebook.com/orthancdicom/>`__ and
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
14 `Twitter <https://twitter.com/OrthancServer>`__).
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
15 - Answer our `survey
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
16 <http://www.orthanc-server.com/static.php?page=blog#survey>`_.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
17 - Improve and translate the `Wikipedia pages
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
18 <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc.
174
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 152
diff changeset
19 - Cite the `reference paper about Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 152
diff changeset
20 <https://link.springer.com/article/10.1007/s10278-018-0082-y>`__
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 152
diff changeset
21 in your research work.
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
22 - Answer questions posted to the `mailing list
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
23 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 151
diff changeset
24 - Improve the text of the `Orthanc Book
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 151
diff changeset
25 <https://bitbucket.org/sjodogne/orthanc-book/>`_ (check out the "How to contribute"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 151
diff changeset
26 section in the README).
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
27 - Provide documentation and use cases (inside the dedicated `GitHub
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
28 repository <https://github.com/jodogne/OrthancContributed>`_, via
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
29 pull requests).
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
30 - Index external contributions inside the `Links.md
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
31 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
32 file.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
33
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
34 * **Maintenance tasks**:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
35
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
36 - Report problems together with sample DICOM images and possible
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
37 workarounds on the `issue tracker
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
38 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
39 - Package Orthanc and its associated plugins for more UNIX or
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
40 GNU/Linux distributions (e.g. RHEL, CentOS, openSUSE...).
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
41 - Share your maintenance scripts or sample code inside the "`Orthanc Contributed
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
42 <https://github.com/jodogne/OrthancContributed>`_" public GitHub
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
43 repository, via pull requests.
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
45 * **Coding tasks**:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
46
204
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
47 - The Orthanc project will happily accept patches in the core of
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
48 Orthanc and in its associated official plugins. Please read the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
49 :ref:`dedicated FAQ entry <cla>`.
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
50 - Interface Orthanc with other software (e.g. 3D Slicer,
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
51 Matlab/Octave, Python, Horos, dicompyler...). Check the `already
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
52 supported frameworks <http://www.orthanc-server.com/static.php?page=resources>`_.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
53 - Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
54 of possible plugins:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
55
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
56 + Create a :ref:`more advanced Web interface
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
57 <improving-interface>` than the built-in Orthanc Explorer.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
58 + Extend the :ref:`sample modality worklist plugin <worklist>` so
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
59 that it manages the worklists (i.e. add/remove items) with a
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
60 REST API or HL7 messages, instead of reading them from some
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
61 folder on the filesystem.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
62 + Have a look at the TODO file containing our `official roadmap
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
63 <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__.
20
98c0c61e7931 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
64
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
65 - Always remember that he **recommended way of contributing to the
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
66 source code of Orthanc is by creating C/C++ plugins**. If the
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
67 current plugin SDK is insufficient for you to develop some feature
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
68 as a plugin, do not hesitate to request an extension to the
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
69 Orthanc SDK on the `mailing list
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
70 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
71
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
72
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
73 * **Financial support**:
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
75 - Participate in our `crowdfunding campaigns
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
76 <http://www.orthanc-server.com/static.php?page=contribute>`__.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
77 - Buy commercial services:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
78
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
79 + Osimis provides `support packages
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
80 <http://www.orthanc-server.com/orthanc-pro.php>`__ dedicated to Orthanc.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
81 + Currently, Osimis is the only company ensuring such corporate
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
82 services according to an open-source business model, but others
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
83 might show up in the future. `Please warn us
180
4b4ede94381e preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 174
diff changeset
84 <mailto:s.jodogne@orthanc-labs.com>`__ if your know about another such
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
85 company!