RELEASE.md

Release Instructions

Pre-Commit

1. fix-n-fmt
2. make test

Release

1. git checkout main; git pull origin main
2. git checkout -b <username>/<version>
3. Bump version number in version in Cargo.toml
4. Update CHANGELOG.md
5. make docs
6. git add .
7. git commit -m '<version>'
8. git push origin <username>/<version>
   • Or with graphite: gt branch track and gt stack submit
9. Create a pull request off this branch
   • Make sure the name of the pull request is also just the <version> so the workflow will know to do a release
   • Do not prepend the <version> with v. For instance, if releasing 1.1.0, the PR should be named 1.1.0, NOT v1.1.0
10. Merge the pull request
11. Verify release appears on PyPI