Changes between Version 14 and Version 15 of Developers/DevelopingCodeChanges
- Timestamp:
- 2016-01-14T11:18:00+01:00 (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Developers/DevelopingCodeChanges
v14 v15 47 47 * Detailed list of specific tests, see below 48 48 49 Once the wiki page is completed by PI (detailed implementation plan), the PI will submit it to Previewer. The Previewer will discuss with PI to reach full agreement on detailed implementation plan (in a maximum of 2 weeks starting when PI submits wiki page to Previewer).[[BR]]The PI is responsible to give all requested details.[[BR]]The Previewer is responsible to check with all experts that implementation plan is indeed coorect and compatible with the other developments going on in parallel during the year. 49 Once the wiki page is completed by PI (detailed implementation plan), the PI will submit it to Previewer. The Previewer will discuss with PI to reach full agreement on detailed implementation plan (in a maximum of 2 weeks starting when PI submits wiki page to Previewer).[[BR]]The PI is responsible to give all requested details.[[BR]]The Previewer is responsible to check with all experts that implementation plan is indeed coorect and compatible with the other developments going on in parallel during the year. Objective is to avoid the need for a full rewriting at the end (which did happen sometimes previously) 50 50 51 51 == Start the coding == 52 Once the Previewer has sent the green light (approval of detailed implementation plan and summary of changes in reference manual), the PI can created the corresponding development branch. The branch should be created from the up to date version of NEMO as chosen for each year (usually the trunk at a give fixed revision for a give year, see minutes of NEMO System Team videoconferences.Development can progress on this new branch.52 Once the Previewer has sent the green light (approval of detailed implementation plan and summary of changes in reference manual), the PI can created the corresponding development branch. The branch should be created from the up to date version of NEMO as chosen for each year (usually the trunk at a give fixed revision for a give year, see minutes of NEMO System Team videoconferences. Development can progress on this new branch. 53 53 54 Each year, development branches will be created in the directory svn/nemo/branches/YEAR/"standard name of dev branch". 54 Each year, development branches will be created in the directory svn/nemo/branches/YEAR/"standard name of dev branch". [[BR]]"standard name of dev branch" should be: dev_"starting revision number"_"workplan item_purpose" (ex dev_r1302_LOCEAN1_mpp) 55 55 56 56 === Develop your Change === … … 66 66 * full sucessfull SETTE tests: to check nothing is broken or goes wrong in the reference configurations SETTE tests: if running with some changes in the results, those have to be justified and checked in detail. New code should not change results when it is switched off, and not alter results when tuned on. 67 67 * full succesfull specific tests: to be defined before starting, in order to check that development does indeed what is expected 68 * ''Add here possible use of Trusting tool for a development branch (Nicolas?)'' 68 69 69 70 == Document your Change == 70 * Any change will need documenting. If the documentation is fairly short (i.e. a small change with strictly limited impact), then the ticket will be an appropriate place for this. If documentation is more extensive, then a Trac wiki page should be used. 71 72 * The convention for naming wiki pages associated with tickets is to replace "ticket/xxxx" with "wiki/ticket/xxxx" for ticket number "xxx". 73 * The wiki page can be created by including the markup !wiki:ticket/xxxx (where xxxx is your ticket number) in your ticket and then following the link. 74 * A sample wiki template (!https://forge.ipsl.jussieu.fr/nemo/wiki/PageTemplates/NEMOTicketTemplate) is provided when creating the wikipage 71 * Progress in the development should be documented as the work goes on in the ticket created at the beginning/ 72 * Code should be documented on line as defined in the coding rules 73 * Changes in the reference manual should be also written as soon as possible, and before review process 75 74 76 75 == Science/Tech/Code Review ==