diff --git a/docs/developers/releasing.md b/docs/developers/releasing.md index 899cc00..eb2b5bd 100644 --- a/docs/developers/releasing.md +++ b/docs/developers/releasing.md @@ -1,7 +1,8 @@ # Release Workflow 1. Update version in `Cargo.toml` -2. Commit change with a meaningful message (`v0.1.1`) -3. Tag commit using `git tag -a -m "$(git shortlog ..HEAD)"` -4. Push the tag using `git push --tags` -5. Publish package using `cargo publish` +1. Add entry in `CHANGELOG.md` +1. Commit change with semantic version number (`v0.1.1`) +1. Tag commit using `git tag -a -m "$(git shortlog ..HEAD)"` +1. Push the tag using `git push --tags` +1. Publish package using `cargo publish`