# HG changeset patch # User Sebastien Jodogne # Date 1499329815 -7200 # Node ID 09b0a61f194292e707ec410debdfddc188374c8c # Parent af1e13dac7e6be5ab9314834942e3c3dd5930240 improved contributing diff -r af1e13dac7e6 -r 09b0a61f1942 Sphinx/source/contributing.rst --- a/Sphinx/source/contributing.rst Tue Jun 13 20:35:14 2017 +0200 +++ b/Sphinx/source/contributing.rst Thu Jul 06 10:30:15 2017 +0200 @@ -6,45 +6,78 @@ If you find Orthanc useful and wish to contribute to its development, here are some tasks you can take in charge that would greatly help us: -* Use Orthanc in the real life. ;) -* Report possible problems together with sample DICOM images on the - `issue tracker - `_. -* Answer questions posted to the `mailing list - `_. -* Index external contributions on the "`Orthanc Contributed - `_" GitHub - repository, via pull requests. -* Provide documentation and use cases (e.g. on `GitHub `_). -* Share maintenance scripts (e.g. on `GitHub `_). -* Advertise about Orthanc, and answer the `survey `_. -* Package Orthanc and its associated plugins for more UNIX or - GNU/Linux distributions (e.g. RHEL, CentOS, SUSE...). -* Improve and translate the `Wikipedia page - `_ about Orthanc. -* Interface Orthanc with other software (e.g. 3D Slicer, - Matlab/Octave, Python, Horos, dicompyler...). Check the `already - supported frameworks `_. -* Develop :ref:`C/C++ plugins extending the Orthanc core `. Here are some ideas - of possible plugins: +* **Non-coding tasks**: + + - Use Orthanc in the real life. ;) + - Advertise about Orthanc, notably on social networks (we are active + on `Facebook `__ and + `Twitter `__). + - Answer our `survey + `_. + - Improve and translate the `Wikipedia pages + `_ about Orthanc. + - Answer questions posted to the `mailing list + `_. + - Provide documentation and use cases (inside the dedicated `GitHub + repository `_, via + pull requests). + - Index external contributions inside the `Links.md + `_ + file. + +* **Maintenance tasks**: + + - Report problems together with sample DICOM images and possible + workarounds on the `issue tracker + `_. + - Package Orthanc and its associated plugins for more UNIX or + GNU/Linux distributions (e.g. RHEL, CentOS, openSUSE...). + - Share your maintenance scripts or sample code inside the "`Orthanc Contributed + `_" public GitHub + repository, via pull requests. + - Improve the text of the `Orthanc Book + `_. + - The Orthanc project will also happily accept **external patches** + in the core of Orthanc and in its associated official + plugins. Such patches can either be sent to the `mailing list + `_ or via a + `pull request `_. - * Check the TODO file of the `official roadmap `__. - * Create a :ref:`more advanced Web interface ` than the built-in Orthanc Explorer. - * Extend the :ref:`sample modality worklist plugin ` so that it manages the worklists - (i.e. add/remove items) with a REST API or HL7 messages, instead of reading them from - some folder on the filesystem. - -* Have a look at the `Orthanc Wishlist board `__, - where users can submit their ideas for the future features of Orthanc. +* **Coding tasks**: + + - Interface Orthanc with other software (e.g. 3D Slicer, + Matlab/Octave, Python, Horos, dicompyler...). Check the `already + supported frameworks `_. + - Develop :ref:`C/C++ plugins extending the Orthanc core `. Here are some ideas + of possible plugins: + + + Create a :ref:`more advanced Web interface + ` than the built-in Orthanc Explorer. + + Extend the :ref:`sample modality worklist plugin ` so + that it manages the worklists (i.e. add/remove items) with a + REST API or HL7 messages, instead of reading them from some + folder on the filesystem. + + Have a look at the TODO file containing our `official roadmap + `__. -Always remember that he **recommended way of contributing to the source code of Orthanc is -by creating C/C++ plugins**. If the current plugin SDK is insufficient -for you to develop some feature as a plugin, do not hesitate to -request an extension to the Orthanc SDK on the `mailing list -`_. + - Always remember that he **recommended way of contributing to the + source code of Orthanc is by creating C/C++ plugins**. If the + current plugin SDK is insufficient for you to develop some feature + as a plugin, do not hesitate to request an extension to the + Orthanc SDK on the `mailing list + `_. + + +* **Financial support**: -The Orthanc project will also happily accept **external patches** in -the core of Orthanc and in its associated official plugins. Such -patches can either be sent to the `mailing list -`_ or via a -pull request. + - Participate in our `crowdfunding campaigns + `__. + - Buy commercial services: + + + Osimis provides `support packages + `__ dedicated to Orthanc. + + Currently, Osimis is the only company ensuring such corporate + services according to an open-source business model, but others + might show up in the future. `Please warn us + `__ if your know about another such + company!