Changes between Version 80 and Version 81 of Developers/Dev Process


Ignore:
Timestamp:
2018-11-05T21:19:14+01:00 (19 months ago)
Author:
nemo
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developers/Dev Process

    v80 v81  
    66 
    77== Summary 
    8  
    9 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. 
    108 
    119||=Action       || ''${ACTION_NAME} Subject''                             || 
     
    1715||=Reviewer(s)  || ''Names''                                              || 
    1816||=Wiki         || wiki:!${YEAR}WP/!${ACTION_NAME}...                     || 
     17 
     18These sections 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. 
    1919 
    2020=== Description 
     
    3131=== Documentation updates 
    3232 
    33 Using part 1 and 2, define the summary of changes to be done in the NEMO literature (manuals, guide, web pages, ...). 
     33Using previous parts, define the main changes to be done in the NEMO literature (manuals, guide, web pages, ...). 
    3434 
    35 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. 
     35''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.'' 
    3636 
    3737== Preview #preview_ 
    3838 
    39 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). \\ 
    40 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. 
     39''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). \\ 
     40For 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.'' 
    4141 
    42 ||= Question                                                                                                      ||= Answer \\('YES'|'NO'|'NA') || 
    43 || '''Does the previewer agree with the proposed methodology?'''                                                  ||                             || 
    44 || '''Does the previewer agree with the proposed flowchart and list of routines to be changed?'''                 ||                             || 
    45 || '''Does the previewer agree with the proposed new list of variables, including agreement with coding rules?''' ||                             || 
    46 || '''Does the previewer agree with the proposed summary of updates in reference manual?'''                       ||                             || 
     42||= Question                                                                                                ||= Answer \\('YES'|'NO'|'NA') || 
     43|| Does the previewer agree with the proposed methodology?                                                  ||                             || 
     44|| Does the previewer agree with the proposed flowchart and list of routines to be changed?                 ||                             || 
     45|| Does the previewer agree with the proposed new list of variables, including agreement with coding rules? ||                             || 
     46|| Does the previewer agree with the proposed summary of updates in literature?                             ||                             || 
    4747 
    48 Once all 'YES' have been reached, preview is ended and the PI can start the development into his development branch. 
     48''Once all 'YES' have been reached, preview is ended and the PI can start the development into his development branch.'' 
    4949 
    5050== Tests #tests 
    5151 
    52 ||= Question                                                                                                                                 ||= Answer \\('YES'|'NO'|'NA') || 
    53 || Can this change be shown to produce expected impact? (if option activated)?                                                               ||                             || 
    54 || Can this change be shown to have a null impact? (if option not activated)                                                                 ||                             || 
    55 || Detailed results of restartability and reproducibility when the option is activated. Please indicate the configuration used for this test ||                             || 
    56 || Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration)                              ||                             || 
    57 || Results of the required bit comparability tests been run: Are there no differences when activating the development?                       ||                             || 
    58 || If some differences appear, is reason for the change valid/understood?                                                                    ||                             || 
    59 || If some differences appear, is the !ticket describing in detail the impact this change will have on model configurations?                 ||                             || 
    60 || Is this change expected to preserve all diagnostics?                                                                                      ||                             || 
    61 || If no, is reason for the change valid/understood?                                                                                         ||                             || 
    62 || Are there significant changes in run time/memory?                                                                                         ||                             || 
     52||= Question                                                                                                                                   ||= Answer \\('YES'|'NO'|'NA') || 
     53|| Can this change be shown to produce expected impact (option activated)?                                                                     ||                             || 
     54|| Can this change be shown to have a null impact (option not activated)?                                                                      ||                             || 
     55|| Detailed results of restartability and reproducibility when the option is activated. \\Please indicate the configuration used for this test ||                             || 
     56|| Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration)                                ||                             || 
     57|| Results of the required bit comparability tests been run: are there no differences when activating the development?                         ||                             || 
     58|| If some differences appear, is reason for the change valid/understood?                                                                      ||                             || 
     59|| If some differences appear, is the impact as expected on model configurations?                                                              ||                             || 
     60|| Is this change expected to preserve all diagnostics?                                                                                        ||                             || 
     61|| If no, is reason for the change valid/understood?                                                                                           ||                             || 
     62|| Are there significant changes in run time/memory?                                                                                           ||                             || 
    6363 
    6464== Review #review 
    6565 
    66 Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review. \\ 
    67 A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
     66''Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review. \\ 
     67A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November).'' 
    6868 
    6969=== Code changes and documentation 
    7070 
    71 ||= Question                                                                                                                                                                                           ||= Answer \\('YES'|'NO'|'NA') || 
    72 || Is the proposed methodology now implemented?                                                                                                                                                        ||                             || 
    73 || Are the code changes in agreement with the flowchart defined at Preview step?                                                                                                                       ||                             || 
    74 || Are the code changes in agreement with list of routines and variables as proposed at Preview step? \\If, not, are the discrepancies acceptable?                                                     ||                             || 
    75 || Is the in-line documentation accurate and sufficient?                                                                                                                                               ||                             || 
    76 || Do the code changes comply with NEMO coding standards?                                                                                                                                              ||                             || 
    77 || Is the !ticket of development documented with sufficient details for others to understand the impact of the change?                                                                                 ||                             || 
    78 || Are the reference manual tex files now updated following the proposed summary in preview section?                                                                                                   ||                             || 
    79 || 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. ||                             || 
     71||= Question                                                                                                                                       ||= Answer \\('YES'|'NO'|'NA') || 
     72|| Is the proposed methodology now implemented?                                                                                                    ||                             || 
     73|| Are the code changes in agreement with the flowchart defined at Preview step?                                                                   ||                             || 
     74|| Are the code changes in agreement with list of routines and variables as proposed at Preview step? \\If, not, are the discrepancies acceptable? ||                             || 
     75|| Is the in-line documentation accurate and sufficient?                                                                                           ||                             || 
     76|| Do the code changes comply with NEMO coding standards?                                                                                          ||                             || 
     77|| Is the development documented with sufficient details for others to understand the impact of the change?                                        ||                             || 
     78|| Is the project literature (manual, guide, web, ...) now updated or completed following the proposed summary in preview section?                 ||                             || 
    8079 
    8180=== Finding 
    8281 
    83  * '''Is the review fully successful?''' 
    84  * '''If not, please indicate date and what is still missing?''' 
     82* __Is the review fully successful?__ 
     83* __If not, please indicate date and what is still missing?__ 
    8584 
    86 Once review is successful, the development must be scheduled for merge during next Merge Party Meeting. 
     85''Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.''