First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.
Before creating bug reports, please check if the issue has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main
. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- Use the present tense ("Add feature" not "Added feature")
- Follow the conventional commit format (see conventional commits)
- Reference issues and pull requests liberally after the first line
All Rust must adhere to the Rust style guide.
Don't hesitate to create a new issue or contact us by email at [email protected]