Create changelog

This commit is contained in:
Joscha 2024-12-02 20:43:37 +01:00
parent af3c2deb7f
commit 1edd5927c2

18
CHANGELOG.md Normal file
View file

@ -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