Skip to content

Commit c8012ce

Browse files
committed
clarify what failing tests &add step to run regression tests
1 parent bd2e20f commit c8012ce

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/atmospheric_physics/development_workflow.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ This page describes the general workflow for adding new developments to the [atm
77
The general workflow for adding a feature, bug-fix, or modification to atmospheric_physics is as follows:
88

99
1. [**Open an issue.**](#1-open-an-issue)
10-
2. **[Add your code modifications](#3-update-your-code-with-changes-from-the-official-repo) to a branch on your [fork](#2-create-a-fork-if-you-havent-already).**
11-
3. **[Add/amend unit tests](#5-unit-testing)**
12-
3. **[Open a PR](#6-creating-a-pull-request-pr) from your branch to the `development` branch.**
13-
4. **Respond to any reviewer requests.**
14-
5. **Fix any failing tests.**
15-
6. **[Update `doc/NamesNotInDictionary.txt` file.](#updating-namesnotindictionarytxt-file)**
16-
7. **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.**
17-
8. **Squash the commits and merge the PR (e.g. the "squash and merge" option).**
10+
1. **[Add your code modifications](#3-update-your-code-with-changes-from-the-official-repo) to a branch on your [fork](#2-create-a-fork-if-you-havent-already).**
11+
1. **[Add/amend unit tests](#5-unit-testing)**
12+
1. **[Open a PR](#6-creating-a-pull-request-pr) from your branch to the `development` branch.**
13+
1. **Respond to any reviewer requests.**
14+
1. **Fix any failing automated Github tests.**
15+
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.**
16+
1. **[Update `doc/NamesNotInDictionary.txt` file.](#updating-namesnotindictionarytxt-file)**
17+
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.**
18+
1. **Squash the commits and merge the PR (e.g. the "squash and merge" option).**
1819

1920
If you need an official tag for your new additions, then once your `development` PR has been merged you will need to do the following:
2021

0 commit comments

Comments
 (0)