Changes between Version 26 and Version 27 of Developers/DevProcess
- Timestamp:
- 2016-02-23T20:06:31+01:00 (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Developers/DevProcess
v26 v27 1 [[PageOutline( 1-2,,unnumbered)]]1 [[PageOutline(2)]] 2 2 3 = Preview & Review form page for development work = 3 = Form page for development work = 4 || '''Abstract''' || ''`#!TracForm #!subcontext abstract on [tf.form_updated_on:abstract] by [tf.form_updater:abstract]`'' || 5 || '''Preview''' || ''`#!TracForm #!subcontext preview on [tf.form_updated_on:preview] by [tf.form_updater:preview]`'' || 6 || '''Review''' || ''`#!TracForm #!subcontext review on [tf.form_updated_on:review] by [tf.form_updater:review]`'' || 7 8 ---- 9 == Abstract == 4 10 {{{ 5 11 #!TracForm 6 #!submit_label 'Complete header' 7 || '''Action:''' || ''[tf.input:action 'Number & name' 150]'' || 8 || '''PI(S):''' || ''[tf.input:pi 'Names' 100]'' || 9 || '''Linked !ticket:''' || ''[tf.input:ticket # 10]'' || 10 || '''Previewer(s):''' || ''[tf.input:previewers 'Names' 100]'' || 11 || '''Reviewer(s):''' || ''[tf.input:reviewers 'Names' 100]'' || 12 }}} 13 {{{ 14 #!TracForm 15 || '''Starting date for preview:''' || ''on [tf.when:2.1] by [tf.who:2.1]'' || 16 || '''Ending date of preview:''' || ''on [tf.form_updated_on:preview] by [tf.form_updater:preview]'' || 17 || '''Starting date of review:''' || ''on [tf.when:3.1] by [tf.who:3.1]'' || 18 || '''Ending date of review:''' || ''on [tf.form_updated_on:review] by [tf.form_updater:review]'' || 19 }}} 20 ---- 21 == PI(S) section: detail of the action == 22 This section should be completed before starting to develop the code, in order to find agreement on the method and the implementation beforehand. 12 #!subcontext abstract 13 #!submit_label 'Submit Abstract' 14 || Action || ''[tf.input:action 'Number & name' 150]'' || 15 || PI(S) || ''[tf.input:pi 'Names' 100]'' || 16 || Linked !ticket || ''[tf.input:ticket # 10]'' || 17 || Previewer(s) || ''[tf.input:previewers 'Names' 100]'' || 18 || Reviewer(s) || ''[tf.input:reviewers 'Names' 100]'' || 19 '''This section should be completed before starting to develop the code, in order to find agreement on the method and the implementation beforehand.''' 23 20 24 21 === Part 1: Description === 25 {{{26 #!TracForm27 #!submit_label 'Update description'28 22 [tf.textarea:description 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 200 20] 29 }}} 23 30 24 === Part 2: Implementation === 31 {{{32 #!TracForm33 #!submit_label 'Update implementation'34 25 [tf.textarea:implementation '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 description' 200 20] 35 }}} 26 36 27 === Part 3: Reference manual updates === 37 {{{38 #!TracForm39 #!submit_label 'Update summary'40 28 [tf.textarea:manual 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files)' 200 20] 41 29 }}} 42 '''END of PI's section: 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, and add the date in the Starting date of Preview line of table above.'''30 '''END of PI's section: 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.''' 43 31 44 32 ---- 45 == Preview er(s) section==46 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), see start and end dates of preview above.[[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.'''33 == Preview == 34 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.[[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.''' 47 35 48 36 {{{ 49 37 #!TracForm 50 38 #!subcontext preview 39 #!submit_label 'Submit Preview' 51 40 || Questions || Answer || Comment || 52 || '' 'Does the previewer agree with the proposed methodology?''' || [tf.select:2.1 '' Yes No NR] || [tf.textarea:2.1 'Write here' 50 10] ||53 || '' 'Does the previewer agree with the proposed flowchart and list of routines to be changed?''' || [tf.select:2.2 '' Yes No NR] || [tf.textarea:2.2 'Write here' 50 10] ||54 || '' 'Does the previewer agree with the proposed new list of variables, including agreement with coding rules?''' || [tf.select:2.3 '' Yes No NR] || [tf.textarea:2.3 'Write here' 50 10] ||55 || '' 'Does the previewer agree with the proposed summary of updates in reference manual?''' || [tf.select:2.4 '' Yes No NR] || [tf.textarea:2.4 'Write here' 50 10] ||56 || '' '... ... ...''' || [tf.select:2.X '' Yes No NR] || [tf.textarea:2.X 'Write here' 50 10] ||41 || ''Does the previewer agree with the proposed methodology?'' || [tf.select:2.1 '' Yes No NR] || [tf.textarea:2.1 'Write here' 50 10] || 42 || ''Does the previewer agree with the proposed flowchart and list of routines to be changed?'' || [tf.select:2.2 '' Yes No NR] || [tf.textarea:2.2 'Write here' 50 10] || 43 || ''Does the previewer agree with the proposed new list of variables, including agreement with coding rules?'' || [tf.select:2.3 '' Yes No NR] || [tf.textarea:2.3 'Write here' 50 10] || 44 || ''Does the previewer agree with the proposed summary of updates in reference manual?'' || [tf.select:2.4 '' Yes No NR] || [tf.textarea:2.4 'Write here' 50 10] || 45 || ''... ... ...'' || [tf.select:2.X '' Yes No NR] || [tf.textarea:2.X 'Write here' 50 10] || 57 46 }}} 58 [[BR]] Once all "YES" have been reached, Ending date of preview should be added in table above, and the PI can start the development into his development branch.47 [[BR]]'''Once all "YES" have been reached, the PI can start the development into his development branch.''' 59 48 60 49 ---- 61 == Review er(s) section==62 Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review , and add the date in the table above. A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November).50 == Review == 51 Once the development is done, the PI should complete the tests section below and ask the reviewers to start their review. A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 63 52 64 === Test section (to be completed be PI) ===65 53 {{{ 66 54 #!TracForm 67 #!subcontext preview 55 #!subcontext review 56 #!submit_label 'Submit Review' 57 === Tests === 68 58 || Questions || Answer || Comment || 69 59 || Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 '' Yes No NR] || [tf.textarea:3.1 'Write here' 50 10] || … … 78 68 || Are there significant changes in run time/memory? || [tf.select:3.10 '' Yes No NR] || [tf.textarea:3.10 'Write here' 50 10] || 79 69 || ... ... ... || [tf.select:3.XX '' Yes No NR] || [tf.textarea:3.XX 'Write here' 50 10] || 80 }}}81 70 === Code changes and documentation === 82 {{{83 #!TracForm84 #!subcontext preview85 71 || Question || Answer || Comment || 86 72 || Is the proposed methodology now implemented? || [tf.select:3.11 '' Yes No NR] || [tf.textarea:3.11 'Write here' 50 10] || … … 93 79 || 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 '' Yes No NR] || [tf.textarea:3.18 'Write here' 50 10] || 94 80 || ... ... ... || [tf.select:3.XXX '' Yes No NR] || [tf.textarea:3.XXX 'Write here' 50 10] || 81 === Review Summary === 82 '''Is the review fully successful?'''[tf.select:status '' Yes No][[BR]] 83 [tf.textarea:status 'If not, please indicate what is still missing.' 50 10] 95 84 }}} 96 === Review Summary === 97 {{{ 98 #!TracForm 99 #!subcontext preview 100 * '''Is the review fully successful?''' 101 * '''If not, please indicate date and what is still missing?''' 102 }}} 103 Once review is successful, the of end of review should be added in table at top of the page, and the development must be scheduled for merge during next Merge Party Meeting. 85 Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.
