Skip to content

Commit a1aba20

Browse files
committed
add a few more details to the release checklist
1 parent 4dd389d commit a1aba20

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ releasing.
7676
### step 1
7777

7878
Make sure the [unit tests][jltest] and [CircleCI integration tests][circlecI]
79-
are passing.
79+
are passing off the `dev` branch.
8080

8181
### step 2
8282

@@ -89,7 +89,10 @@ For consistency, name the PR: "Release X.Y.Z"
8989
Bump the `version` field in the `Project.toml` (following [semver][semver]) and then
9090

9191
```sh
92+
git checkout dev
93+
git pull origin dev
9294
git commit -m "X.Y.Z"
95+
git push
9396
```
9497

9598
**N.B.** use `X.Y.Z` not `vX.Y.Z` in the commit message, the leading `v` is
@@ -131,8 +134,8 @@ git push --tags
131134
Go the [release page][releases] and create a new release,
132135
name it "Version X.Y.Z" for consistency and fill out sections:
133136

134-
- _What's Changed_, which should include items for all the PRs merged since the last release
135-
- _New Contributor_, which should include mention of all the first-time contributors
137+
- (usually) _Added_, _Changed_, _Fixed_ while including links to the PRs merged since the last release
138+
- _New Contributor_, which should include mentions for all the first-time contributors
136139

137140
finally, place a [GitHub compare link][compare] between the last release and X.Y.Z
138141
e.g. this [one][ex-diff].

0 commit comments

Comments
 (0)