Skip to content

Commit

Permalink
Make small grammar tweaks to Release Checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb531 committed Dec 31, 2023
1 parent ca1bc9a commit 14d44d5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions .github/RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ properly publish a release to GitHub and PyPI.
- [ ] Run tests and coverage report (`coverage run -m nose2`)
- [ ] All tests pass
- [ ] Code coverage is over 90% for all files
- [ ] Update Migration Guide with details on breaking API changes and upgrade path
- [ ] Update README and Migration Guide with latest major release (e.g. v8)
- [ ] Update Migration Guide with details of any breaking API changes and
upgrade path, if applicable
- [ ] Update README and Migration Guide with latest major release (e.g. v8),
if applicable
- [ ] Write release notes for new release
- [ ] Check copyright line break in README (there should be two spaces after
the *Copyright <year> Caleb Evans* line; sometimes these can get removed
Expand All @@ -22,9 +24,9 @@ properly publish a release to GitHub and PyPI.
- [ ] `git pull`
- [ ] `git merge develop`
- [ ] Commit version bump in `pyproject.toml`
- [ ] Commit message must be `Prepare v<new_version> release`, e.g. `Prepare v8.0.0 release`
- [ ] Commit message must be `Prepare v<new_version> release` (e.g. `Prepare v8.0.0 release`)
- [ ] Tag commit with new release number
- [ ] Tag name must be v-prefixed, followed by the semantic version, e.g.
- [ ] Tag name must be v-prefixed, followed by the semantic version (e.g.
`v8.0.0`)
- [ ] Push new commit and tag with `git push && git push --tags`
- [ ] Post-Release
Expand Down

0 comments on commit 14d44d5

Please sign in to comment.