source: NEMO/branches/2020/dev_r12563_ASINTER-06_ABL_improvement/CONTRIBUTING.rst

Last change on this file was 11734, checked in by nicolasmartin, 14 months ago

Review README for reference confgiurations

File size: 3.3 KB
Line 
1************
2Contributing
3************
4
5.. todo::
6
7
8
9.. contents::
10   :local:
11
12Sending feedbacks
13=================
14
15|  Sending feedbacks is a useful way to contribute to NEMO efficency and reliability. Before doing so,
16   please check here :forge:`search <search on the developement platform>` in wiki, tickets, forum and online
17   documentation if the subject has already been discussed. You can either contribute to an existing
18   discussion, or
19| Create an entry for the discussion online, according to your needs
20
21- You have a question: create a topic in the appropriate :forge:`discussion <forum>`
22- You would like to raise and issue: open a new ticket of the right type depending of its severity
23
24  - "Unavoidable" :forge:`newticket?type=Bug       <bug>`
25
26  - "Workable"    :forge:`newticket?type=Defect <defect>`
27
28Please follow the guidelines and try to be as specific as possible in the ticket description.
29
30New development
31===============
32
33You have build a development relevant for NEMO shared reference: an addition of the source code,
34a full fork of the reference, ...
35
36You may want to share it with the community (see Hack below) or to propose it for implementation in the future
37NEMO release (see Proposal / Task below).
38
39The proposals for developments to be included in the shared NEMO reference are first examined by NEMO Developers
40Committee / Scientific Advisory Board.
41The implementation of a new development requires some additionnal work from the intial developer.
42These tasks will need to be scheduled with NEMO System Team.
43
44
45Hack
46----
47
48You only would like to inform NEMO community about your developments.
49You can promote your work on NEMO forum gathering  the contributions fromof the community by creating
50a specific topic here :forge:`discussion/forum/5 <dedicated forum>`
51
52
53Proposal / Task
54---------------
55
56| Your development is quite small, and you would only like to offer it as a possible enhancement. Please suggest it
57  as an enhancement here :forge:`newticket?type=Enhancement <enhancement>` . It will be taken in account, if
58  feasible, by NEMO System Team. To ease the process, it is suggested, rather than attaching the modified
59  routines to the ticket, to highlight the proposed changes by adding to the ticket the output of ``svn diff``
60  or ``svn patch`` from your working copy.
61
62| Your development seems relevant for addition into the future release of NEMO shared reference.
63  Implementing it into NEMO shared reference following the usual quality control will require some additionnal work
64  from you and also from the NEMO System Team in charge of NEMO development. In order to evaluate the work,
65  your suggestion should be send as a proposed enhancement here :forge:`newticket?type=Enhancement <enhancement>`
66  including description of the development, its implementation, and the existing validations.
67
68  The proposed enhancement will be examined  by NEMO Developers Committee / Scientific Advisory Board.
69  Once approved by the  Committee, the assicated development task can be scheduled in NEMO development work plan,
70  and tasks distributed between you as initial developer and PI of this development action, and the NEMO System Team.
71
72  Once sucessful (meeting the usual quality control steps) this action will allow the merge of these developments with
73  other developments of the year, building the future NEMO.
Note: See TracBrowser for help on using the repository browser.