Changes between Version 28 and Version 29 of Developers/DevelopingCodeChanges

Timestamp:

2016-02-24T18:05:42+01:00 (8 years ago)

Author:

nicolasmartin

Comment:

--

Developers/DevelopingCodeChanges

@@ -30 +30 @@
 Once the workplan has been approved, the code development is planned. The PI should create:
 
- * A !ticket to start the work. This !ticket will describe the purpose of the action, so as Pi and Previewer name.
- * An associated wiki page to be created in wiki/2016WP/ACTION_Nb_PI using the [http://forge.ipsl.jussieu.fr/nemo/wiki/PageTemplates/NEMO_Devlt_Preview_and_ReviewTemplate development preview and review template]. This page will permit to follow the ongoing work through different steps and will be linked to the !ticket. IMPORTANT: you need to create the wiki page in the wiki workplan of the year section, with appropriate name (ACTION_Nb_PI), using the template called [http://forge.ipsl.jussieu.fr/nemo/wiki/PageTemplates/NEMO_Devlt_Preview_and_ReviewTemplate NEMO_Devlt_Preview_and_ReviewTemplate]                          once first edit started (you do not have write access to the template itself).
+ * An '''associated wiki page''' to be created in `wiki/${YEAR}WP/${WORKING_GROUP}-${ACTION_NUMBER}_${PI}` using this '''[wiki:PageTemplates/Devlt_Work_Form template]''', you can customize it while editing in the !TracForm container. The wiki page will describe:
+   * Purpose, motivation and main tasks of the action
+   * PI(S) & (P)Reviewer(s) name(s)
+   * Detailed  implementation plan: scientific, technical and an expected summary  of changes for NEMO reference manual to be written later.
+   * Detailed list of specific tests, see below
+   * (P)Review status
 
-The other fields in the !ticket (e.g. Priority, Milestone, Keywords etc) should also be set appropriately.
+This page will permit to follow the ongoing work through different  steps and will go with:
 
- * The !''milestone!'' field should be set to the area the change is being targeted for.
- * The !ticket !''type!'' field should be set to "development branch"
- * Associated wiki page should be created by including the markup !wiki:ticket/xxxx (where xxxx is your !ticket number) in your !ticket and then following the link.
- * The !ticket should be assigned to the code developer, '''previewers and possible followers should be added in the 'cc' field for further email notification.'''
+ * A '''linked !ticket''' to gather the group discussion. The following fields have to be set in a appropriate way:
+   * ''''Cc': (P)Reviewer(s) and possible follower(s) should be added for further email notification.'''
+   * 'Component': the area the change is being targeted for.
+   * 'Type': 'development branch'
+   * 'Owner': the code developer
 
-The wiki page will describe:
+The other fields in the !ticket (e.g. 'Priority', 'Milestone', 'Keywords') should also be set appropriately.
 
- * Purpose and associated action number on workplan
- * Motivation
- * Status
- * Main tasks
- * Pi name
- * Previewer(s) name
- * Detailed implementation plan (scientific and technical): list of files and routine names of the code to be changed or created, new variable names (following coding rules)... This is also expected to be used as summary of changes to NEMO reference manual to be written later
- * Detailed list of specific tests, see below
-
-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)
-
+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 correct 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)
 == Start the coding ==
 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.