Changes between Version 90 and Version 91 of Developers/Dev Process


Ignore:
Timestamp:
2019-10-25T11:59:08+02:00 (11 months ago)
Author:
nemo
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developers/Dev Process

    v90 v91  
    77== Summary #summary 
    88 
    9 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. 
    10  
    11 ||=Action       || ''{ACTION_NAME} Subject''                             || 
    12 ||=PI(S)        || ''Names''                                             || 
    13 ||=Digest       || ''Brief description with motivations and main tasks'' || 
    14 ||=Dependencies || ''If any''                                            || 
    15 ||=Branch       || source:/NEMO/branches/{YEAR}/dev_r{REV}_{ACTION_NAME} || 
    16 ||=Previewer(s) || ''Names''                                             || 
    17 ||=Reviewer(s)  || ''Names''                                             || 
    18 ||=Wiki         || wiki:{YEAR}WP/{ACTION_NAME}                           || 
     9The following sections should be completed by the PI of the development, before starting to develop the code,  
     10in order to find agreement on the method and the implementation beforehand. 
    1911 
    2012=== Description 
     
    2719Describe flow chart of the changes in the code. \\ 
    2820List 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 and description wrt coding rules. 
     21Detailed list of new variables to be defined (including namelists),  
     22give for each the chosen name and description wrt coding rules. 
    3023 
    3124=== Documentation updates 
    3225 
    33 Using previous parts, define the main changes to be done in the NEMO literature (manuals, guide, web pages, ...). 
     26Using previous parts, define the main changes to be done in the NEMO literature  
     27(manuals, guide, web pages, ...). 
    3428 
    3529---- 
     
    3933== Preview #preview_ 
    4034 
    41 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). \\ 
     35Since the preview step must be completed before the PI starts the coding,  
     36the previewer(s) answers are expected to be completed within the two weeks after  
     37the PI has sent the request to the previewer(s). \\ 
    4238Then an iterative process should take place between PI and previewer(s) in order to find a consensus 
    4339 
    44 __Possible bootlenecks__: 
     40__Possible bottlenecks__: 
    4541- the methodology 
    4642- the flowchart and list of routines to be changed 
    47 - the new list of variables wrt coding rules 
     43- the new list of variables ''wrt'' coding rules 
    4844- the summary of updates in literature 
    4945 
     
    5450== Tests #tests 
    5551 
    56 Once the development is done, the PI should complete the tests section below and after ask the reviewers to start their review. 
     52Once the development is done, the PI should complete the tests section below and  
     53after ask the reviewers to start their review. 
    5754 
    58 This 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 
     55This part should contain the detailed results of SETTE tests  
     56(restartability and reproducibility for each of the reference configuration) and  
     57detailed results of restartability and reproducibility when  
     58the option is activated on specified configurations used for this test 
    5959 
    6060__Regular checks__: 
    6161- Can this change be shown to produce expected impact (option activated)?                                                
    6262- Can this change be shown to have a null impact (option not activated)? 
    63 - Results of the required bit comparability tests been run: are there no differences when activating the development? 
     63- Results of the required bit comparability tests been run:  
     64  are there no differences when activating the development? 
    6465- If some differences appear, is reason for the change valid/understood?                                                                       
    6566- If some differences appear, is the impact as expected on model configurations?                                                               
     
    7071== Review #review 
    7172 
    72 A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
     73A successful review is needed to schedule the merge of this development into the future NEMO release during 
     74next Merge Party (usually in November). 
    7375 
    7476__Assessments__: 
    7577- Is the proposed methodology now implemented? 
    7678- Are the code changes in agreement with the flowchart defined at preview step? 
    77 - Are the code changes in agreement with list of routines and variables as proposed at preview step? \\If, not, are the discrepancies acceptable? 
     79- Are the code changes in agreement with list of routines and variables as proposed at preview step? \\ 
     80  If, not, are the discrepancies acceptable? 
    7881- Is the in-line documentation accurate and sufficient? 
    7982- Do the code changes comply with NEMO coding standards? 
    8083- Is the development documented with sufficient details for others to understand the impact of the change? 
    81 - Is the project literature (manual, guide, web, ...) now updated or completed following the proposed summary in preview section? 
     84- Is the project literature (manual, guide, web, ...) now updated or completed following  
     85  the proposed summary in preview section? 
    8286 
    8387__Finding__: