We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
- Fork the repo and create your branch from
main
. - If you've added code that should be tested, add tests.
- If you've changed user interface or configuration file code, update the documentation
- Ensure the test suite passes, run
cargo test
to run the tests - Make sure your code lints, run
cargo fmt
to format the code and follow the lint rules withcargo clippy
. - Issue that pull request!
By contributing, you agree that your contributions will be licensed under its MIT License.