103 | | At this stage (autumn 2019), we are building the list of possible actions for 2020. The 2020 work plan will be finalised by end of the year, with advice from the Developers Committee and decisions from the Steering committee. |
104 | | |
105 | | The 2020 workplan must be realistic |
106 | | |
107 | | To add a proposed action in 2020 work plan, you need to create the wiki page (all actions) and (only for 2020 IMMERSE actions) the associated ticket. The steps are detailed below: |
108 | | |
109 | | '''Naming convention'''[[BR]] |
110 | | The name of an action must follow the convention: "STREAM"_"NUMBER"_"login of PI"_"keyword" [[BR]] |
111 | | Following this convention, the name of the wiki page will be: forge.ipsl.jussieu.fr/nemo/wiki/2020WP/"STREAM"_"NUMBER"_"login of PI"_"keyword" |
| 103 | At this stage (autumn 2019), we are building the list of possible actions for 2020. The 2020 work plan will be finalised by end of the year, with advice from the Developers Committee and decisions from the Steering committee.[[BR]] |
| 104 | The 2020 workplan must be realistic. Each action must define the 2020 objecitve. If the action is expected to take more than one year, it should be explained in the Description section of the associated wiki page.[[BR]] |
| 105 | To ad an action in 2020 work plan proposal, you need to create the wiki page (for all actions) and the associated ticket (for 2020 IMMERSE actions only, since those are for sure already). [[BR]] |
| 106 | Once the 2020 workplan will be finalised (after Steering Committee meeting) each action will need its wiki page (action description) and its ticket (following the state of the work).[[BR]] |
| 107 | |
| 108 | |
| 109 | '''Important: naming convention for actions an their wiki page'''[[BR]] |
| 110 | The name of an action must follow the convention: "STREAM"_"NUMBER"_"login of PI"_"keyword" , to be used both to name its wiki page and its ticket.[[BR]] |
| 111 | Following this convention, '''the name of the wiki page must be: forge.ipsl.jussieu.fr/nemo/wiki/2020WP/"STREAM"_"NUMBER"_"login of PI"_"keyword"''' |
117 | | * '''Choose the template '!Workplan/Action' (mandatory)'''[[BR]] |
118 | | * and create the wiki page. |
119 | | |
120 | | === 2/ Complete description of action in the wiki page |
121 | | '''It is mandatory to complete the informations of the first part of the ticket :''' |
122 | | * Abstract |
123 | | Including a statement on the objective by end 2020: feasible meaning it is scheduled with associated resources, desirable meaning is is hoped to be completed |
124 | | * Context |
| 117 | * '''Choose the template '!Workplan/Action' (mandatory) and create the wiki page.''' This will open the new page in edit mode, allowing you to move to step 2: |
| 118 | |
| 119 | === 2/ Complete the mandatory fields in the wiki page |
| 120 | * In the Summary section following fields (= those in bold) must be completed: |
| 121 | * '''Action''' = Name and subject of the action |
| 122 | * '''PI(S) Names''' |
| 123 | * '''Digest''' = one sentence stating motivations and main tasks |
| 124 | * '''Dependencies''' = taksks needing to be completed before this action can start, if any |
| 125 | * Branch = name of development branch following naming convention (source:/NEMO/branches/{YEAR}/dev_r{REV}_{ACTION_NAME}, to add once preview is completed, e.g. not at this stage |
| 126 | * '''Previewer(s)Names''' |
| 127 | * '''Reviewer(s) Names''' |
| 128 | * '''Ticket''' = number of associated ticket (, to be added once ticket is created, e.g. '''only for IMMERSE actions for now''') |
| 129 | |
| 130 | |
| 131 | * '''Description section (mandatory)''': |
| 132 | Please complete this section in plain English, readable by all. |
| 133 | Description should include: |
| 134 | * '''goal of development and the methodology''' |
| 135 | * '''reference documents''' or publications if relevant |
| 136 | * '''precise statement of the objective by end 2020''' |
| 137 | * If the action is expected to continue after 2020, some elements on the context |
| 138 | * '''a statement on the priority''' : the action will be qualified as '''feasible''' if it is listed with associated commitment of the PI, or '''desirable''' meaning if is is hoped to be completed |
| 139 | |
| 140 | The other sections of wiki page (implementation, documentation update, preview, tests etc... are expected to be completed as the action work is going on. [[BR]][[BR]] |