Mercurial > hg > orthanc-book
changeset 104:09b0a61f1942
improved contributing
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 06 Jul 2017 10:30:15 +0200 |
parents | af1e13dac7e6 |
children | 268ec482f051 |
files | Sphinx/source/contributing.rst |
diffstat | 1 files changed, 72 insertions(+), 39 deletions(-) [+] |
line wrap: on
line diff
--- 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 - <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_. -* Answer questions posted to the `mailing list - <https://groups.google.com/forum/#!forum/orthanc-users>`_. -* Index external contributions on the "`Orthanc Contributed - <https://github.com/jodogne/OrthancContributed>`_" GitHub - repository, via pull requests. -* Provide documentation and use cases (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_). -* Share maintenance scripts (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_). -* Advertise about Orthanc, and answer the `survey <http://www.orthanc-server.com/static.php?page=blog#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 - <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc. -* Interface Orthanc with other software (e.g. 3D Slicer, - Matlab/Octave, Python, Horos, dicompyler...). Check the `already - supported frameworks <http://www.orthanc-server.com/static.php?page=resources>`_. -* Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. 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 <https://www.facebook.com/orthancdicom/>`__ and + `Twitter <https://twitter.com/OrthancServer>`__). + - Answer our `survey + <http://www.orthanc-server.com/static.php?page=blog#survey>`_. + - Improve and translate the `Wikipedia pages + <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc. + - Answer questions posted to the `mailing list + <https://groups.google.com/forum/#!forum/orthanc-users>`_. + - Provide documentation and use cases (inside the dedicated `GitHub + repository <https://github.com/jodogne/OrthancContributed>`_, via + pull requests). + - Index external contributions inside the `Links.md + <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_ + file. + +* **Maintenance tasks**: + + - Report problems together with sample DICOM images and possible + workarounds on the `issue tracker + <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_. + - 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 + <https://github.com/jodogne/OrthancContributed>`_" public GitHub + repository, via pull requests. + - Improve the text of the `Orthanc Book + <https://bitbucket.org/sjodogne/orthanc-book/src/default/Sphinx/source/>`_. + - 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 + <https://groups.google.com/forum/#!forum/orthanc-users>`_ or via a + `pull request <https://bitbucket.org/sjodogne/orthanc/pull-requests/>`_. - * Check the TODO file of the `official roadmap <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__. - * Create a :ref:`more advanced Web interface <improving-interface>` than the built-in Orthanc Explorer. - * Extend the :ref:`sample modality worklist plugin <worklist>` 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 <https://trello.com/b/gcn33tDM/orthanc-wishlist>`__, - 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 <http://www.orthanc-server.com/static.php?page=resources>`_. + - Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas + of possible plugins: + + + Create a :ref:`more advanced Web interface + <improving-interface>` than the built-in Orthanc Explorer. + + Extend the :ref:`sample modality worklist plugin <worklist>` 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 + <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__. -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 -<https://groups.google.com/forum/#!forum/orthanc-users>`_. + - 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 + <https://groups.google.com/forum/#!forum/orthanc-users>`_. + + +* **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 -<https://groups.google.com/forum/#!forum/orthanc-users>`_ or via a -pull request. + - Participate in our `crowdfunding campaigns + <http://www.orthanc-server.com/static.php?page=contribute>`__. + - Buy commercial services: + + + Osimis provides `support packages + <http://www.orthanc-server.com/orthanc-pro.php>`__ 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 + <mailto:s.jodogne@gmail.com>`__ if your know about another such + company!