Mercurial > hg > orthanc-book
comparison Sphinx/source/contributing.rst @ 0:901e8961f46e
initial commit
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 22 Apr 2016 12:57:38 +0200 |
| parents | |
| children | 98c0c61e7931 |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:901e8961f46e |
|---|---|
| 1 Contributing to Orthanc | |
| 2 ======================= | |
| 3 | |
| 4 If you find Orthanc useful and wish to contribute to its development, | |
| 5 here are some tasks you can take in charge that would greatly help us: | |
| 6 | |
| 7 * Use Orthanc in the real life. ;) | |
| 8 * Report possible problems together with sample DICOM images on the | |
| 9 `issue tracker | |
| 10 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_. | |
| 11 * Answer questions posted to the `mailing list | |
| 12 <https://groups.google.com/forum/#!forum/orthanc-users>`_. | |
| 13 * Index external contributions on the "`Orthanc Contributed | |
| 14 <https://github.com/jodogne/OrthancContributed>`_" GitHub | |
| 15 repository, via pull requests. | |
| 16 * Provide documentation and use cases (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_). | |
| 17 * Share maintenance scripts (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_). | |
| 18 * Advertise about Orthanc, and answer the `survey <http://www.orthanc-server.com/static.php?page=blog#survey>`_. | |
| 19 * Package Orthanc and its associated plugins for more UNIX or | |
| 20 GNU/Linux distributions (e.g. RHEL, CentOS, SUSE...). | |
| 21 * Improve and translate the `Wikipedia page | |
| 22 <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc. | |
| 23 * Interface Orthanc with other software (e.g. 3D Slicer, | |
| 24 Matlab/Octave, Python, Horos, dicompyler...). Check the `already | |
| 25 supported frameworks <http://www.orthanc-server.com/static.php?page=resources>`_. | |
| 26 * Develop `C/C++ plugins | |
| 27 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`_, | |
| 28 some ideas of which can be found in the `official roadmap | |
| 29 <https://trello.com/b/cjA9X1wM/orthanc-roadmap>`_. | |
| 30 | |
| 31 | |
| 32 The **recommended way of contributing to the source code of Orthanc is | |
| 33 by creating C/C++ plugins**. If the current plugin SDK is insufficient | |
| 34 for you to develop some feature as a plugin, do not hesitate to | |
| 35 request an extension to the Orthanc SDK on the `mailing list | |
| 36 <https://groups.google.com/forum/#!forum/orthanc-users>`_. | |
| 37 | |
| 38 The University Hospital of Liège will also happily accept **external | |
| 39 patches** in the core of Orthanc and in its associated official | |
| 40 plugins, provided they are put in the public domain. Such patches must | |
| 41 be sent to the `mailing list | |
| 42 <https://groups.google.com/forum/#!forum/orthanc-users>`_ (*not* via a | |
| 43 pull request). |