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


Ignore:
Timestamp:
2018-11-06T17:06:37+01:00 (19 months ago)
Author:
nemo
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developers/Dev Process

    v87 v88  
    66 
    77== Summary 
     8 
     9The 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. 
    810 
    911||=Action       || ''{ACTION_NAME} Subject''                             || 
     
    1618||=Wiki         || wiki:{YEAR}WP/{ACTION_NAME}                           || 
    1719 
    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. 
    19  
    2020=== Description 
    2121 
     
    2525=== Implementation 
    2626 
    27 Describe flow chart of the changes in the code \\ 
    28 List the Fortran modules and subroutines to be created/edited/deleted \\ 
    29 Detailed list of new variables to be defined (including namelists), give for each the chosen name wrt coding rules and description. 
     27Describe flow chart of the changes in the code. \\ 
     28List the Fortran modules and subroutines to be created/edited/deleted. \\ 
     29Detailed list of new variables to be defined (including namelists), give for each the chosen name and description wrt coding rules. 
    3030 
    3131=== Documentation updates 
     
    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. 
     35---- 
     36 
     37Once the PI has completed this section, he should ask the previewer(s) to preview the work within two weeks. 
    3638 
    3739== Preview #preview_ 
    3840 
    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 An iterative process should take place between PI and previewer(s) in order to find a consensus on 
    41                                                                               
     41Since 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). 
     42 
     43Then an iterative process should take place between PI and previewer(s) in order to find a consensus 
     44 
     45__Possible bootlenecks__: 
    4246- the methodology 
    4347- the flowchart and list of routines to be changed 
     
    4549- the summary of updates in literature 
    4650 
     51---- 
     52 
    4753Once an agreement has been reached, preview is ended and the PI can start the development into his branch. 
    4854 
    4955== Tests #tests 
    5056 
    51 Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) 
    52 Detailed results of restartability and reproducibility when the option is activated. \\Please indicate the configuration used for this test 
     57Once the development is done, the PI should complete the tests section below and after ask the reviewers to start their review. 
    5358 
     59This part should contain the detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) and detailed results of restartability and reproducibility when the option is activated on specified configurations used for this test 
     60 
     61__Regular checks__: 
    5462- Can this change be shown to produce expected impact (option activated)?                                                
    5563- Can this change be shown to have a null impact (option not activated)? 
     
    6371== Review #review 
    6472 
    65 Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review. \\ 
    6673A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
    6774 
    68 === Code changes and documentation 
    69  
     75__Assessments__: 
    7076- Is the proposed methodology now implemented? 
    7177- Are the code changes in agreement with the flowchart defined at preview step? 
     
    7682- Is the project literature (manual, guide, web, ...) now updated or completed following the proposed summary in preview section? 
    7783 
    78 === Finding 
     84__Finding__: 
    7985 
    80 * __Is the review fully successful?__ 
    81 * __If not, please indicate date and what is still missing?__ 
     86Is the review fully successful? If not, please indicate what is still missing 
     87 
     88---- 
    8289 
    8390Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.