Changes between Version 86 and Version 87 of Developers/Dev Process


Ignore:
Timestamp:
2018-11-06T16:31:03+01:00 (19 months ago)
Author:
nemo
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developers/Dev Process

    v86 v87  
    1616||=Wiki         || wiki:{YEAR}WP/{ACTION_NAME}                           || 
    1717 
    18 ''The following 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.'' 
     18The following 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 
     
    3333Using 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.'' 
     35Once 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.'' 
     39Since 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). \\ 
     40An iterative process should take place between PI and previewer(s) in order to find a consensus on 
     41                                                                              
     42- the methodology 
     43- the flowchart and list of routines to be changed 
     44- the new list of variables wrt coding rules 
     45- the summary of updates in literature 
    4146 
    42 ||= Question                                                                                       ||= Answer \\('YES'|'NO'|'NA') || 
    43 || Does the previewer agree with the methodology?                                                  ||                             || 
    44 || Does the previewer agree with the flowchart and list of routines to be changed?                 ||                             || 
    45 || Does the previewer agree with the new list of variables, including agreement with coding rules? ||                             || 
    46 || Does the previewer agree with the summary of updates in literature?                             ||                             || 
    47  
    48 ''Once all 'YES' have been reached, preview is ended and the PI can start the development into his development branch.'' 
     47Once an agreement has been reached, preview is ended and the PI can start the development into his branch. 
    4948 
    5049== Tests #tests 
    5150 
    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?                                                                                           ||                             || 
     51Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) 
     52Detailed results of restartability and reproducibility when the option is activated. \\Please indicate the configuration used for this test 
     53 
     54- Can this change be shown to produce expected impact (option activated)?                                                
     55- Can this change be shown to have a null impact (option not activated)? 
     56- Results of the required bit comparability tests been run: are there no differences when activating the development? 
     57- If some differences appear, is reason for the change valid/understood?                                                                       
     58- If some differences appear, is the impact as expected on model configurations?                                                               
     59- Is this change expected to preserve all diagnostics?                                                                                         
     60- If no, is reason for the change valid/understood?                                                                                            
     61- Are there significant changes in run time/memory?                                                                                            
    6362 
    6463== Review #review 
    6564 
    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).'' 
     65Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review. \\ 
     66A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
    6867 
    6968=== Code changes and documentation 
    7069 
    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?                 ||                             || 
     70- Is the proposed methodology now implemented? 
     71- Are the code changes in agreement with the flowchart defined at preview step? 
     72- Are the code changes in agreement with list of routines and variables as proposed at preview step? \\If, not, are the discrepancies acceptable? 
     73- Is the in-line documentation accurate and sufficient? 
     74- Do the code changes comply with NEMO coding standards? 
     75- Is the development documented with sufficient details for others to understand the impact of the change? 
     76- Is the project literature (manual, guide, web, ...) now updated or completed following the proposed summary in preview section? 
    7977 
    8078=== Finding 
     
    8381* __If not, please indicate date and what is still missing?__ 
    8482 
    85 ''Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.'' 
     83Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.