# HG changeset patch # User Sebastien Jodogne # Date 1549986800 -3600 # Node ID 76c76af97a2a2aa4b5d7c1c26a3f98fc0b553048 # Parent b79ef7808f16cc7ade467d0bad5e1d4fe142fc10 cont diff -r b79ef7808f16 -r 76c76af97a2a Sphinx/source/contributing.rst --- a/Sphinx/source/contributing.rst Tue Feb 12 16:20:52 2019 +0100 +++ b/Sphinx/source/contributing.rst Tue Feb 12 16:53:20 2019 +0100 @@ -41,14 +41,12 @@ - Share your maintenance scripts or sample code inside the "`Orthanc Contributed `_" public GitHub repository, via pull requests. - - 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 `_. * **Coding tasks**: + - The Orthanc project will happily accept patches in the core of + Orthanc and in its associated official plugins. Please read the + :ref:`dedicated FAQ entry `. - Interface Orthanc with other software (e.g. 3D Slicer, Matlab/Octave, Python, Horos, dicompyler...). Check the `already supported frameworks `_. diff -r b79ef7808f16 -r 76c76af97a2a Sphinx/source/faq/licensing.rst --- a/Sphinx/source/faq/licensing.rst Tue Feb 12 16:20:52 2019 +0100 +++ b/Sphinx/source/faq/licensing.rst Tue Feb 12 16:53:20 2019 +0100 @@ -188,6 +188,11 @@ described in the sections below. +**Important:** You should always favor the :ref:`creation of a new +plugin ` over modifications to the internal code +(see below)! + + Contributor License Agreement ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -259,7 +264,19 @@ not meet our high-quality code standards, or breaks backward compatibility. Please be sure that we warmly welcome and appreciate your contributions, but be aware of the fact that we are quite - strict, and that the review process might take time. + strict, and that the review process might take time. This is why the + recommended way of contributing to Orthanc is always by + :ref:`creating contributed plugins `. + +* Your pull requests should be kept **as small as possible**, and + should be focused on one very specific issue or feature. Large + architectural changes are reserved for the core development team of + Orthanc, as we must follow our `long-term roadmap + `__. + +* Unit testing is mandatory. Integration tests should be submitted to + the `dedicated repository + `__. * In the case of a doubt wrt. a potential contribution, please discuss it on the `Orthanc Users