You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/atmospheric_physics/development_workflow.md
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ The general workflow for adding a feature, bug-fix, or modification to atmospher
9
9
1.[**Open an issue.**](#1-open-an-issue)
10
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
11
3.**[Add/amend unit tests](#5-unit-testing)**
12
-
3.**[Open a PR](#5-creating-a-pull-request-pr) from your branch to the `development` branch.**
12
+
3.**[Open a PR](#6-creating-a-pull-request-pr) from your branch to the `development` branch.**
@@ -18,10 +18,10 @@ The general workflow for adding a feature, bug-fix, or modification to atmospher
18
18
19
19
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:
20
20
21
-
1.**Open a PR that merges the atmospheric_physics `development` branch into `main`. Ensure that the PR description lists every PR that went into `development` since the last update to `main`.**
21
+
1.**Open a PR that merges the atmospheric_physics `development` branch into `main`. Ensure that the PR description lists the title and number of every PR that went into `development` since the last update to `main`.**
22
22
2.**Fix any failing tests. This includes tests on the target host models that will be using the new tag.**
23
23
3.**Merge (do not squash!) the PR.**
24
-
4.**Tag the new merge commit.**
24
+
4.**[Tag](Tagging-Instructions.md) the new merge commit.**
25
25
26
26
## Workflow details
27
27
@@ -224,7 +224,10 @@ At a minimum, unit tests for ESCOMP source code should:
224
224
225
225
**11. Update the `NamesNotInDictionary.txt` file using the instructions [below](#updating-namesnotindictionarytxt-file).**
226
226
227
-
**12. Once all reviewers sign off on your modifications, then the PR will be squashed and merged. Congratulations! Your code is now in atmospheric_physics!**
227
+
**12. Once all reviewers sign off on your modifications, then the PR can be merged. Congratulations! Your code is now in atmospheric_physics!**
228
+
229
+
- If the PR is to `develop`, you should select "Squash and Merge"
230
+
- If the PR is to `main`, DO NOT squash and instead select "Merge Commit"
0 commit comments