Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This space is intended to capture the extensive documentation on all answer changing code features that you want to include in ACME model code base. Before such a feature can be integrated into the code, it needs to go through the Code Review process that is defined in /wiki/spaces/CNCL/pages/25231511 page. The procedures and pages described below in Instructions exactly follow the defined review process.

 

Tip
titleInstructions

 

 Follow this steps to integrate your answer changing code into ACME code base:

  1. Give your feature a unique, short name in a form:
    1. [ A, O, L, C, P,W, S ]number_Feature-xyz   
      start with the 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 ,   O2_MPAS-LI-in-ACME, A1_CLUBB
  2. 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', title it with the name of your feature
  3. Click on the new page, then under this page create 
    1. Design Document Confluence page for your new ACME code feature  - using template 'ACME Design Document'
    2. Verification , Validation and Performance Phase 1 pages with appropriate templates
    3. Phase 2 Plan - use 'ACME CR Phase 2 Plan'
    4. Coupled Performance and Coupled Validation pages use 'ACME Coupled Performance' or 'ACME Coupled Validation' templates
  4. On the main feature page, please fill in the dependencies table, when ready issue a PR and assign it to an integrator, when he/she is done, they should fill in the integration done date 
  5. 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

See example documentation in O1_Template-1 example feature documentation.

...