Mercurial > hg > orthanc-book
comparison Sphinx/source/developers/repositories.rst @ 627:53992cb7fa7f
c++03
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 06 Mar 2021 11:35:51 +0100 |
parents | 1248dadca1cd |
children | 63f246134e5b |
comparison
equal
deleted
inserted
replaced
626:68c6c251e348 | 627:53992cb7fa7f |
---|---|
153 This section explains the `two accepted ways for communicating | 153 This section explains the `two accepted ways for communicating |
154 contributions | 154 contributions |
155 <https://www.mercurial-scm.org/wiki/CommunicatingChanges>`__: by | 155 <https://www.mercurial-scm.org/wiki/CommunicatingChanges>`__: by |
156 submitting a patch, or by exchanging a bundle. | 156 submitting a patch, or by exchanging a bundle. |
157 | 157 |
158 Importantly, before any contribution can be accepted into the Orthanc | 158 |
159 repositories, its author must sign a :ref:`CLA <cla>`. This allows | 159 Code quality |
160 both the University Hospital of Liège and the Osimis company to act as | 160 ............ |
161 the official guardians of the whole Orthanc ecosystem. | 161 |
162 | 162 * Your code **must follow the C++03 standard** (C++11 is not accepted |
163 Also, make sure to read our :ref:`FAQ if submitting code | 163 for maximum cross-platform compatibility on older platforms). |
164 <submitting_code>`. | 164 |
165 * The continuous integration servers of Osimis check that Orthanc | |
166 properly compiles on Ubuntu 16.04, on `Linux Standard Base systems | |
167 <https://refspecs.linuxfoundation.org/lsb.shtml>`__ using the `LSB | |
168 SDB 5.0.0 | |
169 <http://ftp.linuxfoundation.org/pub/lsb/bundles/released-5.0.0/sdk/>`__, | |
170 on FreeBSD, on Microsoft Visual Studio 2008 (32 bit), on Microsoft | |
171 Visual Studio 2015 (64 bit), and on Apple OS X 10.9 | |
172 "Mavericks". Submitted code might have to be adapted to compile on | |
173 these platforms. Architecture-dependant code should be located in | |
174 the `Orthanc::Toolbox | |
175 <https://hg.orthanc-server.com/orthanc/file/default/OrthancFramework/Sources/Toolbox.h>`__ | |
176 and `Orthanc::SystemToolbox | |
177 <https://hg.orthanc-server.com/orthanc/file/default/OrthancFramework/Sources/SystemToolbox.h>`__ | |
178 static classes. | |
179 | |
180 * Please stick to the :ref:`coding style <coding-style>` of Orthanc. | |
181 | |
182 * Your individual contributions should be kept **as small as | |
183 possible**, and should be focused on one very specific issue or | |
184 feature. Large architectural changes are reserved for the core | |
185 development team of Orthanc, as we must follow our `long-term | |
186 roadmap | |
187 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__. | |
188 | |
189 * Unit testing is mandatory. Integration tests should be submitted to | |
190 the `dedicated repository | |
191 <https://hg.orthanc-server.com/orthanc-tests/file/default>`__. | |
192 | |
193 * All the contributions will be carefully reviewed. Some contributions | |
194 may be modified, yet even rejected. A rejection might for instance | |
195 occur if your contribution does not match the Orthanc roadmap, does | |
196 not meet our high-quality code standards, or breaks backward | |
197 compatibility. Please be sure that we warmly welcome and appreciate | |
198 your contributions, but be aware of the fact that we are quite | |
199 strict, and that the review process might take time. This is why the | |
200 recommended way of contributing to Orthanc is always by | |
201 :ref:`creating contributed plugins <creating-plugins>`. | |
202 | |
203 * Importantly, before any contribution can be accepted into the | |
204 Orthanc repositories, its author must sign a :ref:`CLA <cla>`. This | |
205 allows both the University Hospital of Liège and the Osimis company | |
206 to act as the official guardians of the whole Orthanc | |
207 ecosystem. Another advantage of creating plugins is that signing a | |
208 CLA is not needed. Make sure to carefully read our :ref:`FAQ about | |
209 the licensing of submitted code <submitting_code>`. | |
165 | 210 |
166 | 211 |
167 .. _hg-patch: | 212 .. _hg-patch: |
168 | 213 |
169 Simple patch (import/export) | 214 Simple patch (import/export) |