Changes between Version 90 and Version 91 of Developers/DevProcess
- Timestamp:
- 2019-10-25T11:59:08+02:00 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Developers/DevProcess
v90 v91 7 7 == Summary #summary 8 8 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} || 9 The following sections should be completed by the PI of the development, before starting to develop the code, 10 in order to find agreement on the method and the implementation beforehand. 19 11 20 12 === Description … … 27 19 Describe flow chart of the changes in the code. \\ 28 20 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 and description wrt coding rules. 21 Detailed list of new variables to be defined (including namelists), 22 give for each the chosen name and description wrt coding rules. 30 23 31 24 === Documentation updates 32 25 33 Using previous parts, define the main changes to be done in the NEMO literature (manuals, guide, web pages, ...). 26 Using previous parts, define the main changes to be done in the NEMO literature 27 (manuals, guide, web pages, ...). 34 28 35 29 ---- … … 39 33 == Preview #preview_ 40 34 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). \\ 35 Since the preview step must be completed before the PI starts the coding, 36 the previewer(s) answers are expected to be completed within the two weeks after 37 the PI has sent the request to the previewer(s). \\ 42 38 Then an iterative process should take place between PI and previewer(s) in order to find a consensus 43 39 44 __Possible bo otlenecks__:40 __Possible bottlenecks__: 45 41 - the methodology 46 42 - the flowchart and list of routines to be changed 47 - the new list of variables wrtcoding rules43 - the new list of variables ''wrt'' coding rules 48 44 - the summary of updates in literature 49 45 … … 54 50 == Tests #tests 55 51 56 Once the development is done, the PI should complete the tests section below and after ask the reviewers to start their review. 52 Once the development is done, the PI should complete the tests section below and 53 after ask the reviewers to start their review. 57 54 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 55 This part should contain the detailed results of SETTE tests 56 (restartability and reproducibility for each of the reference configuration) and 57 detailed results of restartability and reproducibility when 58 the option is activated on specified configurations used for this test 59 59 60 60 __Regular checks__: 61 61 - Can this change be shown to produce expected impact (option activated)? 62 62 - 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? 64 65 - If some differences appear, is reason for the change valid/understood? 65 66 - If some differences appear, is the impact as expected on model configurations? … … 70 71 == Review #review 71 72 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). 73 A successful review is needed to schedule the merge of this development into the future NEMO release during 74 next Merge Party (usually in November). 73 75 74 76 __Assessments__: 75 77 - Is the proposed methodology now implemented? 76 78 - 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? 78 81 - Is the in-line documentation accurate and sufficient? 79 82 - Do the code changes comply with NEMO coding standards? 80 83 - 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? 82 86 83 87 __Finding__: