There are some things that should be kept in mind when contributing to this project.
- Commit messages must follow the conventional commits specification. This enables automated CHANGELOG.md generation by using
git-cliff
. - Each commit is should pass CI on its own.
Make sure CI is not failing. Then:
# <release> should follow semantic versioning
git commit -am "chore: release <release>"
git tag "<release>"
git cliff -o CHANGELOG.md
git push && git push --tags