Skip to content

Commit c24b294

Browse files
committed
modify workflow and tagging instructions
1 parent 5d82ee6 commit c24b294

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/atmospheric_physics/Tagging-Instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This page lists instructions for how to create a new atmospheric_physics tag. A
44

55
1. Tags should always be annotated (no lightweight tags).
66
2. Tags should follow the naming convention listed [below](#tag-naming-conventions).
7-
3. Tags should point to merge commits into the main branch.
7+
3. All merge commits into the main branch should be tagged.
88
4. Tags can only be created by people who have write access.
99

1010
## How to create a git tag via the command line

docs/atmospheric_physics/development_workflow.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The general workflow for adding a feature, bug-fix, or modification to atmospher
99
1. [**Open an issue.**](#1-open-an-issue)
1010
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).**
1111
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.**
1313
4. **Respond to any reviewer requests.**
1414
5. **Fix any failing tests.**
1515
6. **[Update `doc/NamesNotInDictionary.txt` file.](#updating-namesnotindictionarytxt-file)**
@@ -18,10 +18,10 @@ The general workflow for adding a feature, bug-fix, or modification to atmospher
1818

1919
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:
2020

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`.**
2222
2. **Fix any failing tests. This includes tests on the target host models that will be using the new tag.**
2323
3. **Merge (do not squash!) the PR.**
24-
4. **Tag the new merge commit.**
24+
4. **[Tag](Tagging-Instructions.md) the new merge commit.**
2525

2626
## Workflow details
2727

@@ -224,7 +224,10 @@ At a minimum, unit tests for ESCOMP source code should:
224224

225225
**11. Update the `NamesNotInDictionary.txt` file using the instructions [below](#updating-namesnotindictionarytxt-file).**
226226

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"
228231

229232
### Updating NamesNotInDictionary.txt file
230233

0 commit comments

Comments
 (0)