diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/contributing.rst	Fri Apr 22 12:57:38 2016 +0200
@@ -0,0 +1,43 @@
+Contributing to Orthanc
+=======================
+
+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 `C/C++ plugins
+  <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`_,
+  some ideas of which can be found in the `official roadmap
+  <https://trello.com/b/cjA9X1wM/orthanc-roadmap>`_.
+
+
+The **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>`_.
+
+The University Hospital of Liège will also happily accept **external
+patches** in the core of Orthanc and in its associated official
+plugins, provided they are put in the public domain. Such patches must
+be sent to the `mailing list
+<https://groups.google.com/forum/#!forum/orthanc-users>`_ (*not* via a
+pull request).