Skip to content

Latest commit

 

History

History
23 lines (13 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

23 lines (13 loc) · 1.33 KB

Contribution guide

Thank you for investing your time in contributing to this project! We appreciate all kinds of contributions ranging from filing issues,comments on issues, pull requests, and code reviews.

Issues

When creating an issue, search for existing issues. Provide a minimal, reproducible example and explain your configuration. Please keep in mind that the maintainers of this project are volunteers and may not have the time to debug your issue.

Pull requests

We welcome pull requests. If a pull request fixes an existing issue, include fixes #XXX in the description. For the pull request title, please use the conventional commit format (e.g. fix: do not crash on empty input).

Please make sure that your code is formatted correctly and passes some automated tests. To format and check the code, run

cargo clippy && cargo fmt

Making a release

We use cargo-release to make releases, which you can install with cargo binstall cargo-release or cargo install cargo-release. To update the CI scripts, run cargo dist generate-ci, which uses cargo-dist.

Then run cargo release LEVEL such as cargo release minor as a dry run. When everything works, add --execute.