We follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
We use [the Release Drafter workflow](https://github.com/marketplace/actions/release-drafter) to automatically create a [draft changelog](https://github.com/ZcashFoundation/zebra/releases).
To create the final change log:
- [ ] Delete any trivial changes
- [ ] Combine duplicate changes
- [ ] Edit change descriptions so they are consistent, and make sense to non-developers
- [ ] Check the category for each change
- prefer the "Fix" category if you're not sure
- [ ] Point the GitHub changelog to the version increment commit
#### Change Categories
From "Keep a Changelog":
*`Added` for new features.
*`Changed` for changes in existing functionality.
*`Deprecated` for soon-to-be removed features.
*`Removed` for now removed features.
*`Fixed` for any bug fixes.
*`Security` in case of vulnerabilities.
## Final Testing
- [ ] After tagging the release, test that the exact `cargo install` command works
(`--git` behaves a bit differently to `--path`)
If the build fails after tagging:
1. fix the build
2. check if the fixes changed any extra crates, and do the required version increments