Thank you for your interest in contributing to Aide!
This very short guide contains minimal ground rules regarding what is expected from contributors.
Changelog is based on conventional commit messages, so it is important for all contributors to follow these guideline.
Additionally if a commit is scoped to one or multiple crates in the repository, the crate names must appear in the commit message scope.
The commit that adds some new feature to aide should look like this:
feat(aide): added new feature
Before you even start working on any code, make sure that your contribution fits the project and no one is already working on the same thing.
If you are unsure, feel free to open an issue or start a discussion!
- Create a version bump commit
- Create a tag
git tag release-<crate>-<version> - Generate the changelog with
cargo install git-cliff:
Make sure you delete the old# Changelogtitle in the changelog file.
git cliff --config "crates/<crate>/cliff.toml" --include-path "crates/<crate>/**/*" -l --prepend crates/<crate>/CHANGELOG.md- push the commits and the tag:
git pushandgit push origin release-<crate>-<version>
All contributions are licensed under MIT or Apache-2.0 at your option.