| Version 20 (modified by nicolasmartin, 8 years ago) (diff) |
|---|
Last edited LastModified()?
NEMO Development process: preview and review page
Section 1: Detailed description to be completed by the PI
This section should be completed by the PI of the development, before starting to develop the code, in order to find agreement on the method and the implementation beforehand.
Part 1: Detailed description
Describe the goal of development, and the methodology. Add reference documents or publications if relevant.
Part 2: Detailed implementation
2.1 Describe flow chart of the changes in the code.
2.2 List the F90 files and modules to be changed
2.3 Detailed list of new variables (including namelists) to be defined. Give for each the chosen name (following coding rules), and description
Part 3: Summary of updates to be done in the reference manual
Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files):
END of PI's section: once the PI has completed this section, he should send a mail to the previewer(s), asking them to preview the work within two weeks, and add the date in the Starting date of Preview line of table above.
Section 2: Preview to be completed by the previewer(s)
Since the preview step must be completed before the PI starts the coding, the previewer(s) answers are expected to be completed within the two weeks after the PI has sent the request to the previewer(s), see start and end dates of preview above.
For each question, an iterative process should take place between PI and previewer(s) in order to reach a "YES" answer for each of the following questions.
Once all "YES" have been reached, Ending date of preview should be added in table above, and the PI can start the development into his development branch.
Section 3: Review to be completed by the reviewer(s)
Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review, and add the date in the table above. A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November).
Test section (to be completed be PI)
Code changes and documentation
Review Summary
Once review is successful, the of end of review should be added in table at top of the page, and the development must be scheduled for merge during next Merge Party Meeting.
