Last edited Timestamp?

NEMO Development process: preview and review page

Name and number of action as listed in workplan:	To be completed here
PI of the development:	To be completed here
Number and link to !ticket opened for this development:	To be completed here
Previewer(s) name(s):	To be completed here
Reviewer(s) name(s):	To be completed here
Starting date for preview:	To be completed here
Ending date of preview:	To be completed here
Starting date of review:	To be completed here
Ending date of review:	To be completed here

---

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.

Questions	Discussion	Answer ("YES" or "NO")
Does the previewer agree with the proposed methodology?
Does the previewer agree with the proposed flowchart and list of routines to be changed?
Does the previewer agree with the proposed new list of variables, including agreement with coding rules?
Does the previewer agree with the proposed summary of updates in reference manual?

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 test section below and ask the reviewers to start their review, and add the date in the table above. A sucessful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November)/

Code changes and documentation

Question	Discussion	Answer
Is the proposed methodology now implemented?
Are the code changes in agreement with the flowchart defined at Preview step?		YES/NO
Are the code changes in agrement with list of routines and variables as proposed at Preview step? If, not, are the discrepencies acceptable?		YES/NO
Is the in-line documentation accurate and sufficient?		YES/NO
Do the code changes comply with NEMO coding standards?		YES/NO
Is the !ticket of development documented with sufficient details for others to understand the impact of the change?		YES/NO
Are the reference manual tex files now updated following the proposed summary in preview section?		YES/NO
Is there a need for some documentation on the web pages (in addition to in-line and reference manual)? If yes, please describe and ask PI. A yes answer must include all documentation available.		YES/NO

Testing

Question	Discussion	Answer
Has the NVTK and other jobs been tested with this change?		YES/NO
Have the required bit comparability tests been run?		YES/NO
Can this change be shown to have a null impact? (if option not selected)		YES/NO
If no, is reason for the change valid/understood?		YES/NO/NA
If no, ensure that the ticket details the impact this change will have on model configurations .		YES/NO/NA
Is this change expected to preserve all diagnostics?		YES/NO
If no, is reason for the change valid/understood?		YES/NO/NA
Are there significant changes in run time/memory?		YES/NO

Testing Comments

Add specific testing comments here

Add specific testing comments here

Code Review

Do the code changes comply with NEMO coding standards?	YES/NO
Are code changes consistent with the design of NEMO?	YES/NO
Is the code free of unwanted TABs?	YES/NO
Has the code been wholly (100%) produced by NEMO developers working on NEMO?	YES/NO
If no, ensure collaboration agreement has been added to the ticket keywords

Add specific code comments or suggested alterations here.

Review Summary

Add summary here

Approval for the trunk

YES/NO

The code reviewer may approve the change for the NEMO trunk when:

1. their requests/comments have been addressed satisfactorily.
2. the above check-list has been completed.

or the code reviewer may choose to reject & assign the change back to the code author.