Skip to content

Commit 79fbde1

Browse files
committed
Add a note to verify CAM has not made changes to scheme being converted
1 parent e8e016f commit 79fbde1

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/atmospheric_physics/development_workflow.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The general workflow for adding a feature, bug-fix, or modification to atmospher
1212
1. **[Open a PR](#6-creating-a-pull-request-pr) from your branch to the `development` branch.**
1313
1. **Respond to any reviewer requests.**
1414
1. **Fix any failing automated Github tests.**
15+
1. **If moving code from CAM to atmospheric_physics, diff CAM between the latest tag and the tag where work was branched off from to verify that the moved code did not have any changes while work was being done.** For example, `git diff --name-status cam6_4_xxx...cam6_4_yyy` and check if any files related to the atmospheric_physics PR have (unexpectedly) changed.
1516
1. **RECOMMENDED: Rerun [CAM](https://github.com/ESCOMP/CAM/wiki/CAM-SE-Workflows#run-cam-tests) and/or [CAM-SIMA](../development/cam-testing.md#regression-testing) regression tests to ensure your updates haven't broken anything.**
1617
1. **[Update `doc/NamesNotInDictionary.txt` file.](#updating-namesnotindictionarytxt-file)**
1718
1. **If you know that this PR will need an official tag, then also add the [tag name](Tagging-Instructions.md/#tag-naming-conventions) to the PR description.**
@@ -424,4 +425,4 @@ After which you should see output similar to:
424425
100% tests passed, 0 tests failed out of 1
425426
```
426427

427-
If 100% of the tests pass, you're good to go!
428+
If 100% of the tests pass, you're good to go!

docs/conversion/final-steps.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ It is also good practice to not let there be too much time between merging your
77
## atmospheric_physics
88
Follow the [atmospheric_physics workflow](../atmospheric_physics/development_workflow.md) to open a PR, respond to review requests, and populate the `NamesNotInDictionary.txt` file.
99

10+
!!! Note - verify changes in CAM
11+
Before finalizing the atmospheric_physics pull request, compare the latest CAM tag with the CAM tag you started with when moving code from CAM to atmospheric_physics to check if any changes to moved code was introduced in CAM.
12+
1013
## CAM
1114
Follow the [CAM workflow](https://github.com/ESCOMP/CAM/wiki/CAM-SE-Workflows) to open a PR and respond to review requests. Be sure to include the `ccpp-conversion` label on your PR. Once you are assigned a tag by the gatekeeper, run the tests, update the Changelog, then make the tag and archive the baselines.
1215

@@ -15,4 +18,4 @@ Follow the [CAM workflow](https://github.com/ESCOMP/CAM/wiki/CAM-SE-Workflows) t
1518
1. Follow the [CAM-SIMA workflow](../development/cam-sima-workflow.md) to open a PR, run the regression tests, and (potentially) make a tag. At the very least, you will have the testing updates above and a new atmopsheric_physics hash (which will point to your fork until the atmospheric_physics PR is merged).
1619

1720
## Final touches
18-
1. Once all PRs are merged and tagged, check off the scheme as "Converted" in the [spreadsheet](https://docs.google.com/spreadsheets/d/1_1TTpnejam5jfrDqAORCCZtfkNhMRcu7cul37YTr_WM/edit?gid=0#gid=0).
21+
1. Once all PRs are merged and tagged, check off the scheme as "Converted" in the [spreadsheet](https://docs.google.com/spreadsheets/d/1_1TTpnejam5jfrDqAORCCZtfkNhMRcu7cul37YTr_WM/edit?gid=0#gid=0).

0 commit comments

Comments
 (0)