|
24
|
1 .. _contributing:
|
|
|
2
|
|
0
|
3 Contributing to Orthanc
|
|
|
4 =======================
|
|
|
5
|
|
|
6 If you find Orthanc useful and wish to contribute to its development,
|
|
|
7 here are some tasks you can take in charge that would greatly help us:
|
|
|
8
|
|
|
9 * Use Orthanc in the real life. ;)
|
|
|
10 * Report possible problems together with sample DICOM images on the
|
|
|
11 `issue tracker
|
|
|
12 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_.
|
|
|
13 * Answer questions posted to the `mailing list
|
|
|
14 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
|
|
|
15 * Index external contributions on the "`Orthanc Contributed
|
|
|
16 <https://github.com/jodogne/OrthancContributed>`_" GitHub
|
|
|
17 repository, via pull requests.
|
|
|
18 * Provide documentation and use cases (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_).
|
|
|
19 * Share maintenance scripts (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_).
|
|
|
20 * Advertise about Orthanc, and answer the `survey <http://www.orthanc-server.com/static.php?page=blog#survey>`_.
|
|
|
21 * Package Orthanc and its associated plugins for more UNIX or
|
|
|
22 GNU/Linux distributions (e.g. RHEL, CentOS, SUSE...).
|
|
|
23 * Improve and translate the `Wikipedia page
|
|
|
24 <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc.
|
|
|
25 * Interface Orthanc with other software (e.g. 3D Slicer,
|
|
|
26 Matlab/Octave, Python, Horos, dicompyler...). Check the `already
|
|
|
27 supported frameworks <http://www.orthanc-server.com/static.php?page=resources>`_.
|
|
|
28 * Develop `C/C++ plugins
|
|
20
|
29 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`_.
|
|
|
30 Here are some ideas of plugins:
|
|
0
|
31
|
|
20
|
32 * Check the right-hand column of the `official roadmap <https://trello.com/b/cjA9X1wM/orthanc-roadmap>`__.
|
|
|
33 * Create a :ref:`more advanced Web interface <improving-interface>` than the built-in Orthanc Explorer.
|
|
|
34 * Extend the :ref:`sample modality worklist plugin <worklist>` so that it manages the worklists
|
|
|
35 (i.e. add/remove items) with a REST API or HL7 messages, instead of reading them from
|
|
|
36 some folder on the filesystem.
|
|
0
|
37
|
|
20
|
38 * Have a look at the `Orthanc Wishlist board <https://trello.com/b/gcn33tDM/orthanc-wishlist>`__,
|
|
|
39 where users can submit their ideas for the future features of Orthanc.
|
|
|
40
|
|
|
41 Always remember that he **recommended way of contributing to the source code of Orthanc is
|
|
0
|
42 by creating C/C++ plugins**. If the current plugin SDK is insufficient
|
|
|
43 for you to develop some feature as a plugin, do not hesitate to
|
|
|
44 request an extension to the Orthanc SDK on the `mailing list
|
|
|
45 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
|
|
|
46
|
|
|
47 The University Hospital of Liège will also happily accept **external
|
|
|
48 patches** in the core of Orthanc and in its associated official
|
|
|
49 plugins, provided they are put in the public domain. Such patches must
|
|
|
50 be sent to the `mailing list
|
|
|
51 <https://groups.google.com/forum/#!forum/orthanc-users>`_ (*not* via a
|
|
|
52 pull request).
|
