Mercurial > hg > orthanc-book
annotate Sphinx/source/contributing.rst @ 62:4b332c3d7824
moving TODO out of Trello
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 22 Nov 2016 11:33:43 +0100 |
parents | 99b45a963bcf |
children | 329bcab46f5e |
rev | line source |
---|---|
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>`_. | |
40 | 28 * Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas |
29 of possible plugins: | |
0 | 30 |
62
4b332c3d7824
moving TODO out of Trello
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
40
diff
changeset
|
31 * Check the TODO file of the `official roadmap <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__. |
20 | 32 * Create a :ref:`more advanced Web interface <improving-interface>` than the built-in Orthanc Explorer. |
33 * Extend the :ref:`sample modality worklist plugin <worklist>` so that it manages the worklists | |
34 (i.e. add/remove items) with a REST API or HL7 messages, instead of reading them from | |
35 some folder on the filesystem. | |
0 | 36 |
20 | 37 * Have a look at the `Orthanc Wishlist board <https://trello.com/b/gcn33tDM/orthanc-wishlist>`__, |
38 where users can submit their ideas for the future features of Orthanc. | |
39 | |
40 Always remember that he **recommended way of contributing to the source code of Orthanc is | |
0 | 41 by creating C/C++ plugins**. If the current plugin SDK is insufficient |
42 for you to develop some feature as a plugin, do not hesitate to | |
43 request an extension to the Orthanc SDK on the `mailing list | |
44 <https://groups.google.com/forum/#!forum/orthanc-users>`_. | |
45 | |
46 The University Hospital of Liège will also happily accept **external | |
47 patches** in the core of Orthanc and in its associated official | |
48 plugins, provided they are put in the public domain. Such patches must | |
49 be sent to the `mailing list | |
50 <https://groups.google.com/forum/#!forum/orthanc-users>`_ (*not* via a | |
51 pull request). |