Mercurial > hg > orthanc-book

annotate Sphinx/source/contributing.rst @ 470:90e6c20cef1e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
indexing orthanc-gdt python plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 04 Aug 2020 16:53:18 +0200
parents 93c2f780aaef
children c7b2424e4b52
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
358
011b01ccf52d fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 302
diff changeset
16 <https://www.orthanc-server.com/static.php?page=blog#survey>`_.
104
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>`_.
269
182f4fdeeb47 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 246
diff changeset
24 - Improve the text of the `Orthanc Book and REST API documentation
449
2922fb1bd65e fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 445
diff changeset
25 <https://hg.orthanc-server.com/orthanc-book/file/default>`__ (check
361
84e3a2612c36 links to hg
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 360
diff changeset
26 out the instructions provided in the `README file
449
2922fb1bd65e fix links
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 445
diff changeset
27 <https://hg.orthanc-server.com/orthanc-book/file/default/README.md>`__,
361
84e3a2612c36 links to hg
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 360
diff changeset
28 and send us a :ref:`simple patch <hg-patch>`).
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
29 - Provide documentation and use cases (inside the dedicated `GitHub
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
30 repository <https://github.com/jodogne/OrthancContributed>`_, via
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
31 pull requests).
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
32 - Index external contributions inside the `Links.md
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
33 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
34 file.
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 * **Maintenance tasks**:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
37
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
38 - Report problems together with sample DICOM images and possible
445
987fbbc2b59e leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 361
diff changeset
39 workarounds on the dedicated `issue tracker
987fbbc2b59e leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 361
diff changeset
40 <http://bugs.orthanc-server.com/>`_.
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
41 - Package Orthanc and its associated plugins for more UNIX or
246
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 204
diff changeset
42 GNU/Linux distributions (e.g. Ubuntu PPA, RHEL, CentOS, openSUSE...).
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
43 - Share your maintenance scripts or sample code inside the "`Orthanc Contributed
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
44 <https://github.com/jodogne/OrthancContributed>`_" public GitHub
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
45 repository, via pull requests.
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
47 * **Coding tasks**:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
48
204
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
49 - The Orthanc project will happily accept patches in the core of
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
50 Orthanc and in its associated official plugins. Please read the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
51 :ref:`dedicated FAQ entry <cla>`.
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
52 - Interface Orthanc with other software (e.g. 3D Slicer,
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
53 Matlab/Octave, Python, Horos, dicompyler...). Check the `already
358
011b01ccf52d fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 302
diff changeset
54 supported frameworks <https://www.orthanc-server.com/static.php?page=resources>`_.
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
55 - 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
56 of possible plugins:
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
57
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
58 + Create a :ref:`more advanced Web interface
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
59 <improving-interface>` than the built-in Orthanc Explorer.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
60 + Extend the :ref:`sample modality worklist plugin <worklist>` so
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
61 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
62 REST API or HL7 messages, instead of reading them from some
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
63 folder on the filesystem.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
64 + Have a look at the TODO file containing our `official roadmap
360
d217af5e6cb3 links to hg
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 358
diff changeset
65 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__.
20
98c0c61e7931 contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
66
104
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
67 - Always remember that he **recommended way of contributing to the
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
68 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
69 current plugin SDK is insufficient for you to develop some feature
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
70 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
71 Orthanc SDK on the `mailing list
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
72 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
73
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
74
09b0a61f1942 improved contributing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 86
diff changeset
75 * **Financial support**:
0
901e8961f46e initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
456
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 449
diff changeset
77 - Osimis provides `support packs and custom development services
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 449
diff changeset
78 <https://www.osimis.io/en/services.html>`__ around the Orthanc
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 449
diff changeset
79 ecosystem and, more generally, around medical imaging. Buying such
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 449
diff changeset
80 professional services is the best way to make the Orthanc project
93c2f780aaef improvement
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 449
diff changeset
81 sustainable in the long term.