contrib.rst

************
Contributing
************

.. todo::



.. contents::
   :local:

Sending feedbacks
=================

|  Sending feedbacks is a useful way to contribute to NEMO efficency and reliability. Before doing so,
   please check on NEMO develoment platform in wiki, tickets, forum and online
   documentation so as on :NEMO Discourse group:`https://nemo-ocean.discourse.group` if the subject has already been discussed. You can either contribute to an existing
   
   discussion, or
| Create an entry for the discussion online in Discourse, according to your needs

Please follow the guidelines and try to be as specific as possible in the description.

New development
===============

You intend to build or have already build  a development relevant for NEMO shared reference: an addition of the source code,
a full fork of the reference, ...

The proposals for developments to be included in the shared NEMO reference are first examined 
by the group NEMO Officers (officers@nemo-ocean.eu)  representing the group of developers, 
and/or by the chair of NEMO Developers Committee(email). Your message should  include
description of the development, its implementation, and the existing validations.
They will determine if your 
development and proposed actions can be considered in the common yearly NEMO development 
work plan. 
If the Developers Team gives a positive answer, you must follow the :NEMO development workflow
described below in the Proposal/Task section.
Indeed; the implementation of a new development in NEMO Shared reference usually requires some additionnal work from the intial developer.
These tasks will need to be scheduled with NEMO System Team: one of the NEMO officers will sponsor your work and help you in this process


Proposal / Task
---------------

| Your development seems relevant for addition into the future release of NEMO shared reference.
  Implementing it into NEMO shared reference following the usual quality control will require some additionnal work
  from you and also from the NEMO System Team in charge of NEMO development. In order to evaluate the work,

  Once approved by the  Developers Committee, the associcated development tasks can be 
  scheduled in NEMO development work plan,
  and tasks assigned between you as initial developer and PI of this development action, and 
  the NEMO System Team following the tasks listed below: 
- : Coding rules, performances
- : Documentation (in the code, on-line and reference manual)
- : Building the development branch in phase with latest NEMO release- :
- : Validation phase: checking that the development does what is expected, and that it is not breaking any existing feature (in terms of natural, computer sciences and of performances) 
 
 
  Once sucessful (meeting the usual quality control steps) this action will allow the merge of these developments with
  other developments of the year, building the future NEMO.