diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a3f1fc4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +All notable changes to this project will be documented in this file. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). +A dependency update to an incompatible version is considered a breaking change. + +## Releasing a new version + +0. Ensure tests don't fail *ahem* +1. Update dependencies in a separate commit, if necessary +2. Set new version number in [`Cargo.toml`](Cargo.toml) +3. Add new section in this changelog +4. Commit with message `Bump version to X.Y.Z` +5. Create tag named `vX.Y.Z` +6. Push `master` and the new tag to GitHub +7. Publish new version of the crate + +## Unreleased