Mercurial > hg > orthanc-book

comparison Sphinx/source/contributing.rst @ 104:09b0a61f1942

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
improved contributing
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 06 Jul 2017 10:30:15 +0200
parents 329bcab46f5e
children 8753cd3e6735
comparison
equal deleted inserted replaced
103:af1e13dac7e6 104:09b0a61f1942
4 ======================= 4 =======================
5 5
6 If you find Orthanc useful and wish to contribute to its development, 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: 7 here are some tasks you can take in charge that would greatly help us:
8 8
9 * Use Orthanc in the real life. ;) 9 * **Non-coding tasks**:
10 * Report possible problems together with sample DICOM images on the 10
11 `issue tracker 11 - Use Orthanc in the real life. ;)
12 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_. 12 - Advertise about Orthanc, notably on social networks (we are active
13 * Answer questions posted to the `mailing list 13 on `Facebook <https://www.facebook.com/orthancdicom/>`__ and
14 <https://groups.google.com/forum/#!forum/orthanc-users>`_. 14 `Twitter <https://twitter.com/OrthancServer>`__).
15 * Index external contributions on the "`Orthanc Contributed 15 - Answer our `survey
16 <https://github.com/jodogne/OrthancContributed>`_" GitHub 16 <http://www.orthanc-server.com/static.php?page=blog#survey>`_.
17 repository, via pull requests. 17 - Improve and translate the `Wikipedia pages
18 * Provide documentation and use cases (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_). 18 <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc.
19 * Share maintenance scripts (e.g. on `GitHub <https://github.com/jodogne/OrthancContributed>`_). 19 - Answer questions posted to the `mailing list
20 * Advertise about Orthanc, and answer the `survey <http://www.orthanc-server.com/static.php?page=blog#survey>`_. 20 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
21 * Package Orthanc and its associated plugins for more UNIX or 21 - Provide documentation and use cases (inside the dedicated `GitHub
22 GNU/Linux distributions (e.g. RHEL, CentOS, SUSE...). 22 repository <https://github.com/jodogne/OrthancContributed>`_, via
23 * Improve and translate the `Wikipedia page 23 pull requests).
24 <https://en.wikipedia.org/wiki/Orthanc_(software)>`_ about Orthanc. 24 - Index external contributions inside the `Links.md
25 * Interface Orthanc with other software (e.g. 3D Slicer, 25 <https://github.com/jodogne/OrthancContributed/blob/master/Links.md>`_
26 Matlab/Octave, Python, Horos, dicompyler...). Check the `already 26 file.
27 supported frameworks <http://www.orthanc-server.com/static.php?page=resources>`_.
28 * Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas
29 of possible plugins:
30 27
31 * Check the TODO file of the `official roadmap <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__. 28 * **Maintenance tasks**:
32 * Create a :ref:`more advanced Web interface <improving-interface>` than the built-in Orthanc Explorer. 29
33 * Extend the :ref:`sample modality worklist plugin <worklist>` so that it manages the worklists 30 - Report problems together with sample DICOM images and possible
34 (i.e. add/remove items) with a REST API or HL7 messages, instead of reading them from 31 workarounds on the `issue tracker
35 some folder on the filesystem. 32 <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`_.
33 - Package Orthanc and its associated plugins for more UNIX or
34 GNU/Linux distributions (e.g. RHEL, CentOS, openSUSE...).
35 - Share your maintenance scripts or sample code inside the "`Orthanc Contributed
36 <https://github.com/jodogne/OrthancContributed>`_" public GitHub
37 repository, via pull requests.
38 - Improve the text of the `Orthanc Book
39 <https://bitbucket.org/sjodogne/orthanc-book/src/default/Sphinx/source/>`_.
40 - The Orthanc project will also happily accept **external patches**
41 in the core of Orthanc and in its associated official
42 plugins. Such patches can either be sent to the `mailing list
43 <https://groups.google.com/forum/#!forum/orthanc-users>`_ or via a
44 `pull request <https://bitbucket.org/sjodogne/orthanc/pull-requests/>`_.
36 45
37 * Have a look at the `Orthanc Wishlist board <https://trello.com/b/gcn33tDM/orthanc-wishlist>`__, 46 * **Coding tasks**:
38 where users can submit their ideas for the future features of Orthanc. 47
48 - Interface Orthanc with other software (e.g. 3D Slicer,
49 Matlab/Octave, Python, Horos, dicompyler...). Check the `already
50 supported frameworks <http://www.orthanc-server.com/static.php?page=resources>`_.
51 - Develop :ref:`C/C++ plugins extending the Orthanc core <plugins>`. Here are some ideas
52 of possible plugins:
53
54 + Create a :ref:`more advanced Web interface
55 <improving-interface>` than the built-in Orthanc Explorer.
56 + Extend the :ref:`sample modality worklist plugin <worklist>` so
57 that it manages the worklists (i.e. add/remove items) with a
58 REST API or HL7 messages, instead of reading them from some
59 folder on the filesystem.
60 + Have a look at the TODO file containing our `official roadmap
61 <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__.
39 62
40 Always remember that he **recommended way of contributing to the source code of Orthanc is 63 - Always remember that he **recommended way of contributing to the
41 by creating C/C++ plugins**. If the current plugin SDK is insufficient 64 source code of Orthanc is by creating C/C++ plugins**. If the
42 for you to develop some feature as a plugin, do not hesitate to 65 current plugin SDK is insufficient for you to develop some feature
43 request an extension to the Orthanc SDK on the `mailing list 66 as a plugin, do not hesitate to request an extension to the
44 <https://groups.google.com/forum/#!forum/orthanc-users>`_. 67 Orthanc SDK on the `mailing list
68 <https://groups.google.com/forum/#!forum/orthanc-users>`_.
45 69
46 The Orthanc project will also happily accept **external patches** in 70
47 the core of Orthanc and in its associated official plugins. Such 71 * **Financial support**:
48 patches can either be sent to the `mailing list 72
49 <https://groups.google.com/forum/#!forum/orthanc-users>`_ or via a 73 - Participate in our `crowdfunding campaigns
50 pull request. 74 <http://www.orthanc-server.com/static.php?page=contribute>`__.
75 - Buy commercial services:
76
77 + Osimis provides `support packages
78 <http://www.orthanc-server.com/orthanc-pro.php>`__ dedicated to Orthanc.
79 + Currently, Osimis is the only company ensuring such corporate
80 services according to an open-source business model, but others
81 might show up in the future. `Please warn us
82 <mailto:s.jodogne@gmail.com>`__ if your know about another such
83 company!