Changes between Version 10 and Version 11 of Page Templates/Workplan/Action


Ignore:
Timestamp:
2016-10-12T12:43:23+02:00 (4 years ago)
Author:
nicolasmartin
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Page Templates/Workplan/Action

    v10 v11  
    11= ''`${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER}_${PIS}`'' = 
    22 
    3 ''A wiki page associated with a given action should be created in `wiki/${YEAR}WP/${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER}_${PIS}` using this template.Then, detail your action in the 'Summary' sub-page (ordinary wiki page).[[BR]]From that, the rest of the page has to be edited on-line inside the colored form fields and submit your modifications by clicking on the 'Submit ...' at the end of the section.'' 
     3== Help == 
     4 
     5''The development process of each action of the yearly workplan should be described only in one wiki page created in the tree of the corre`wiki/${YEAR}WP/${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER}_${PIS}` using this template.Then, detail your action in the 'Summary' sub-page (ordinary wiki page).[[BR]]From that, the rest of the page has to be edited on-line inside the colored form fields and submit your modifications by clicking on the 'Submit ...' at the end of the section.'' 
     6'''There is absolutely no risk for all form content to make any modification in the wiki page as long as you edit out of `{{{TracForm ... }}}` processor'''. The data of a form field is stored in a different database from the wiki page, so you can delete a version or submit a new one without danger.[[BR]] 
     7 
     8'''For the Trac links to associated !ticket & development branch, it is mandatory to edit the page in `textarea` view'''. The `wysiwyg` view will alter the interpretation of the Trac processors `{{{#!th ... }}}` or `{{{#!td ... }}}` in the table.[[BR]] 
     9''To keep a preview, you can tick the box `edit side-by-side` at top right of the editing frame. It will part your screen with the editing view on the left and the preview on the right so you can control your changes. If you get by default the 'wysiwyg' view, this is due to your last editing work and can be changed in a simple manner.'' 
    410 
    511---- 
     12 
     13The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected.[[BR]] 
     14 
     15[[PageOutline(2)]] 
    616 
    717This is the color code for the fulfilment of this form: 
     
    1626}}} 
    1727 
    18 The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected.[[BR]] 
     28== Summary == 
    1929 
    20 [[PageOutline(2)]] 
    21  
    22 == Summary == 
    2330'''Link for editing the summary:[[ExtractUrl(./Summary)]]''' 
    2431[[Include(./Summary)]] 
    2532 
    2633== Abstract == 
     34 
    2735This section should be completed before starting to develop the code, in order to find agreement on the method beforehand. 
    2836 
     
    3038#!TracForm 
    3139#!subcontext abstract 
    32 #!submit_label 'Submit Abstract' 
     40#!submit_label 'Save Abstract' 
    3341#!keep_history yes 
    3442=== Description === 
    35 [tf.textarea:description -id=piform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 200 20] 
     43 [tf.textarea:description -id=piform -class=taform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 0 20] 
    3644=== Implementation === 
    37 [tf.textarea:implementation -id=piform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 200 20] 
    38 === Reference manual updates === 
    39 [tf.textarea:manual -id=piform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files).' 200 20] 
    40 ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== 
     45 [tf.textarea:implementation -id=piform -class=taform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 0 20] 
     46=== Reference manual and web pages updates === 
     47 [tf.textarea:manual -id=piform -class=taform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files), and in the content of web pages.' 0 20] 
     48 
     49'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    4150}}} 
    4251 
     
    4453 
    4554== Preview == 
     55 
    4656Since 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.[[BR]]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. 
    4757 
     
    4959#!TracForm 
    5060#!subcontext preview_ 
    51 #!submit_label 'Submit Preview' 
     61#!submit_label 'Save Preview' 
    5262|| Questions || Answer || Comment || 
    53 || Does the previewer agree with the proposed methodology? || [tf.select:2.1 -id=preform '' Yes No NR] || [tf.textarea:2.1 -id=preform 'Add a comment?' 50 10] || 
    54 || 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.2 -id=preform 'Add a comment?' 50 10] || 
    55 || 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.3 -id=preform 'Add a comment?' 50 10] || 
    56 || 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.4 -id=preform 'Add a comment?' 50 10] || 
    57 || ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.X -id=preform 'Add a comment?' 50 10] || 
    58 ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== 
     63|| 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] || 
     64|| 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] || 
     65|| 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] || 
     66|| 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] || 
     67|| ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] || 
     68 
     69'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    5970}}} 
     71 
    6072Once all "YES" have been reached, the PI can start the development into his development branch. 
    6173 
    6274== Tests == 
     75 
    6376Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 
    6477 
     
    6679#!TracForm 
    6780#!subcontext tests 
    68 #!submit_label 'Submit Tests' 
     81#!submit_label 'Save Tests' 
    6982|| Questions || Answer || Comment || 
    70 || Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 -id=piform '' Yes No NR] || [tf.textarea:3.1 -id=piform 'Add a comment?' 50 10] || 
    71 || 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.2 -id=piform 'Add a comment?' 50 10] || 
    72 || 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.3 -id=piform 'Add a comment?' 50 10] || 
    73 || 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.4 -id=piform 'Add a comment?' 50 10] || 
    74 || 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.5 -id=piform 'Add a comment?' 50 10] || 
    75 || If some differences appear, is reason for the change valid/understood? || [tf.select:3.6 -id=piform '' Yes No NR] || [tf.textarea:3.6 -id=piform 'Add a comment?' 50 10] || 
    76 || 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.7 -id=piform 'Add a comment?' 50 10] || 
    77 || Is this change expected to preserve all diagnostics? || [tf.select:3.8 -id=piform '' Yes No NR] || [tf.textarea:3.8 -id=piform 'Add a comment?' 50 10] || 
    78 || If no, is reason for the change valid/understood? || [tf.select:3.9 -id=piform '' Yes No NR] || [tf.textarea:3.9 -id=piform 'Add a comment?' 50 10] || 
    79 || Are there significant changes in run time/memory? || [tf.select:3.10 -id=piform '' Yes No NR] || [tf.textarea:3.10 -id=piform 'Add a comment?' 50 10] || 
    80 || ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XX -id=piform 'Add a comment?' 50 10] || 
    81 ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== 
     83|| 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] || 
     84|| 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] || 
     85|| 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] || 
     86|| 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] || 
     87|| 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] || 
     88|| 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] || 
     89|| 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] || 
     90|| 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] || 
     91|| 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] || 
     92|| 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] || 
     93|| ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] || 
     94 
     95'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    8296}}} 
     97 
    8398== Review == 
     99 
    84100A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
    85101 
     
    87103#!TracForm 
    88104#!subcontext review 
    89 #!submit_label 'Submit Review' 
     105#!submit_label 'Save Review' 
    90106=== Code changes and documentation === 
    91107|| Question || Answer || Comment || 
    92 || Is the proposed methodology now implemented? || [tf.select:3.11 -id=revform '' Yes No NR] || [tf.textarea:3.11 -id=revform 'Add a comment?' 50 10] || 
    93 || 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.12 -id=revform 'Add a comment?' 50 10] || 
    94 || Are the code changes in agreement with list of routines and variables as proposed at Preview step?[[BR]]If not, are the discrepancies acceptable? || [tf.select:3.13 -id=revform '' Yes No NR] || [tf.textarea:3.13 -id=revform 'Add a comment?' 50 10] || 
    95 || Is the in-line documentation accurate and sufficient? || [tf.select:3.14 -id=revform '' Yes No NR] || [tf.textarea:3.14 -id=revform 'Add a comment?' 50 10] || 
    96 || Do the code changes comply with NEMO coding standards? || [tf.select:3.15 -id=revform '' Yes No NR] || [tf.textarea:3.15 -id=revform 'Add a comment?' 50 10] || 
    97 || 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.16 -id=revform 'Add a comment?' 50 10] || 
    98 || 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.17 -id=revform 'Add a comment?' 50 10] || 
    99 || Is there a need for some documentation on the web pages (in addition to in-line and reference manual)?[[BR]]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.18 -id=revform 'Add a comment?' 50 10] || 
    100 || ... ... ... || [tf.select:3.XXX -id=revform '' Yes No NR] || [tf.textarea:3.XXX -id=revform 'Add a comment?' 50 10] || 
    101 === Review Summary === 
     108|| 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] || 
     109|| 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] || 
     110|| Are the code changes in agreement with list of routines and variables as proposed at Preview step?[[BR]]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] || 
     111|| 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] || 
     112|| 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] || 
     113|| 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] || 
     114|| 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] || 
     115|| Is there a need for some documentation on the web pages (in addition to in-line and reference manual)?[[BR]]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] || 
     116|| ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 
     117'''__Review Summary__'''[[BR]] 
    102118Is the review fully successful?[tf.select:status -id=revform '' Yes No][[BR]] 
    103 [tf.textarea:status -id=revform 'If not, please indicate what is still missing.' 50 10] 
    104 ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== 
     119[tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 
     120 
     121'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
    105122}}} 
     123 
    106124Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.