Follow this steps to complete the Code Review Process for your answer changing code before introducing it into E3SM code base: | Expand |
|---|
- Give your feature a name that includes the component and short description:
- Use a format [ A, O, L, C, P,W, S ]number_Feature-xyz that starts with a capital letter of your Group followed by a number (unique consecutive number for your group), followed by underscore then any short feature description, for example: O1_MPAS-Ocean-in-ACME , A1_CLUBB
- Create a main Confluence Page to contain all the documentation on your the new feature to be integrated into ACME code, use template 'ACME Code Review' (to create this page, make sure you are on the 127086564 page, click on the three dots (...) icon next to Create icon at the top, blue navigation bar, choose appropriate template and click on 'Create'). Title it with the name of your feature. This page contains two tables, fill them in as described in the template
- A feature dependency table – info from this table will feed the New Features Dependencies Overview page, that will help display the dependencies between feature pull requests
- A table with the checklist of all stages of the review and to obtain approvals for each of the stage of the Code Review
As you work on integrating your feature into ACME code, step along the Checklist table on your main page, obtain the approvals before going to the next step
- Click on your new feature main page (created in #2), and as you go through the checklist of the code review process (second table #2.b) create and fill the appropriate pages:
- Design Document Confluence page for your new code feature - using template 'ACME Design Document'
- Verification , Validation and Performance Phase 1 pages with appropriate templates: 'ACME Code Validation Phase 1', etc..
- Phase 2 Plan - use 'ACME Code Review Phase 2 Plan' (TBD)
- Coupled Performance and Coupled Validation pages use 'ACME Feature Coupled Performance ' or 'ACME Feature Coupled Validation' templates (TBD)
- When the Phase 1 documentation checklist (table #2.b) is satisfied and you have the approval from a Group Lead (the blue section of the table), you are ready to issue a PR and assign it to an integrator. At that point fill in the blue section in the dependencies table (table #2.a) with the name of the PR integrator's name, and after he integrates the code, provide the integration date.
- Phase 2 starts with the Plan document (#3.c). The coupled system integration and testing can and should be done with the aggregate of features, and the planned coupled simulations may validate a combination of feature aggregates if feasible.
|
 See competed example For a good examaple, check this competed documentation: A1 Ozone Hole (Linoz-v2)
|