Changes between Version 3 and Version 4 of 2018WP/VALID-12_CLEVY_Coupled Interface


Ignore:
Timestamp:
2018-11-29T17:18:10+01:00 (22 months ago)
Author:
clevy
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 2018WP/VALID-12_CLEVY_Coupled Interface

    v3 v4  
    3535== Abstract 
    3636 
    37 {{{#!box warn 
    38 This section should be completed before starting to develop the code, in order to find agreement with the previewer(s) on the method beforehand. 
    39 }}} 
    4037 
    4138{{{#!TracForm 
     
    6461 
    6562Once the PI has completed this section, he should send a mail to the previewer(s) asking them to preview the work within two weeks. 
     63== Preview  
    6664 
    67  
    68 {{{#!Fold title=Preview tag=h2 
    69 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 his request. \\ 
    70 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. 
    71  
    72 {{{#!TracForm 
    73 #!subcontext preview_ 
    74 #!submit_label 'Save Preview' 
    75  
    76 ||= Questions =||= Answer =||= Comment =|| 
    77 || Does the previewer agree with the proposed methodology? || [tf.select:2.1 -id=preform '' Yes No NR] || [tf.textarea:2.1c -id=preform 'Add a comment?' 50 10] || 
    78 || Does the previewer agree with the proposed flowchart and list of routines to be changed? || [tf.select:2.2 -id=preform '' Yes No NR] || [tf.textarea:2.2c -id=preform 'Add a comment?' 50 10] || 
    79 || Does the previewer agree with the proposed new list of variables, including agreement with coding rules? || [tf.select:2.3 -id=preform '' Yes No NR] || [tf.textarea:2.3c -id=preform 'Add a comment?' 50 10] || 
    80 || Does the previewer agree with the proposed summary of updates in reference manual? || [tf.select:2.4 -id=preform '' Yes No NR] || [tf.textarea:2.4c -id=preform 'Add a comment?' 50 10] || 
    81 || ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] || 
    82  
    83 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    84  
     65{{{#!box help 
     66[[Include(wiki:Developers/DevProcess#preview_)]] 
    8567}}} 
    8668 
    87 Once all "YES" have been reached, the PI can start the development into his development branch. 
     69== Tests 
    8870 
     71{{{#!box help 
     72[[Include(wiki:Developers/DevProcess#tests)]] 
    8973}}} 
    9074 
     75== Review 
    9176 
    92 {{{#!Fold title=Tests tag=h2 
    93  
    94 Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 
    95  
    96 {{{#!TracForm 
    97 #!subcontext tests 
    98 #!submit_label 'Save Tests' 
    99  
    100 ||= Questions =||= Answer =||= Comment =|| 
    101 || Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 -id=piform '' Yes No NR] || [tf.textarea:3.1c -id=piform 'Add a comment?' 50 10] || 
    102 || Can this change be shown to have a null impact? (if option not activated) || [tf.select:3.2 -id=piform '' Yes No NR] || [tf.textarea:3.2c -id=piform 'Add a comment?' 50 10] || 
    103 || Detailed results of restartability and reproducibility when the option is activated. Please indicate the configuration used for this test || [tf.select:3.3 -id=piform '' Yes No NR] || [tf.textarea:3.3c -id=piform 'Add a comment?' 50 10] || 
    104 || Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) || [tf.select:3.4 -id=piform '' Yes No NR] || [tf.textarea:3.4c -id=piform 'Add a comment?' 50 10] || 
    105 || Results of the required bit comparability tests been run: Are there no differences when activating the development? || [tf.select:3.5 -id=piform '' Yes No NR] || [tf.textarea:3.5c -id=piform 'Add a comment?' 50 10] || 
    106 || If some differences appear, is reason for the change valid/understood? || [tf.select:3.6 -id=piform '' Yes No NR] || [tf.textarea:3.6c -id=piform 'Add a comment?' 50 10] || 
    107 || If some differences appear, is the !ticket describing in detail the impact this change will have on model configurations? || [tf.select:3.7 -id=piform '' Yes No NR] || [tf.textarea:3.7c -id=piform 'Add a comment?' 50 10] || 
    108 || Is this change expected to preserve all diagnostics? || [tf.select:3.8 -id=piform '' Yes No NR] || [tf.textarea:3.8c -id=piform 'Add a comment?' 50 10] || 
    109 || If no, is reason for the change valid/understood? || [tf.select:3.9 -id=piform '' Yes No NR] || [tf.textarea:3.9c -id=piform 'Add a comment?' 50 10] || 
    110 || Are there significant changes in run time/memory? || [tf.select:3.10 -id=piform '' Yes No NR] || [tf.textarea:3.10c -id=piform 'Add a comment?' 50 10] || 
    111 || ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] || 
    112  
    113 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    114  
     77{{{#!box help 
     78[[Include(wiki:Developers/DevProcess#review)]] 
    11579}}} 
    116  
    117 }}} 
    118  
    119  
    120 {{{#!Fold title=Review tag=h2 
    121  
    122 {{{#!box critical 
    123 A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November~December). 
    124 }}} 
    125  
    126 {{{#!TracForm 
    127 #!subcontext review 
    128 #!submit_label 'Save Review' 
    129  
    130  
    131 === Code changes and documentation 
    132  
    133 ||= Question =||= Answer =||= Comment =|| 
    134 || Is the proposed methodology now implemented? || [tf.select:3.11 -id=revform '' Yes No NR] || [tf.textarea:3.11c -id=revform 'Add a comment?' 50 10] || 
    135 || Are the code changes in agreement with the flowchart defined at Preview step? || [tf.select:3.12 -id=revform '' Yes No NR] || [tf.textarea:3.12c -id=revform 'Add a comment?' 50 10] || 
    136 || Are the code changes in agreement with list of routines and variables as proposed at Preview step? \\If not, are the discrepancies acceptable? || [tf.select:3.13 -id=revform '' Yes No NR] || [tf.textarea:3.13c -id=revform 'Add a comment?' 50 10] || 
    137 || Is the in-line documentation accurate and sufficient? || [tf.select:3.14 -id=revform '' Yes No NR] || [tf.textarea:3.14c -id=revform 'Add a comment?' 50 10] || 
    138 || Do the code changes comply with NEMO coding standards? || [tf.select:3.15 -id=revform '' Yes No NR] || [tf.textarea:3.15c -id=revform 'Add a comment?' 50 10] || 
    139 || Is the !ticket of development documented with sufficient details for others to understand the impact of the change? || [tf.select:3.16 -id=revform '' Yes No NR] || [tf.textarea:3.16c -id=revform 'Add a comment?' 50 10] || 
    140 || Are the reference manual tex files now updated following the proposed summary in preview section? || [tf.select:3.17 -id=revform '' Yes No NR] || [tf.textarea:3.17c -id=revform 'Add a comment?' 50 10] || 
    141 || 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. || [tf.select:3.18 -id=revform '' Yes No NR] || [tf.textarea:3.18c -id=revform 'Add a comment?' 50 10] || 
    142 || ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 
    143  
    144  
    145 ==== Review Summary 
    146  
    147 Is the review fully successful? [tf.select:status -id=revform '' Yes No] 
    148  
    149 [tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 
    150  
    151 '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    152  
    153  
    154 }}} 
    155  
    156 Once review is successful, the development must be scheduled for merge during next Merge Party Meeting. 
    157  
    158 }}}