Thank you for investing your time in contributing to this project!
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
If you spot a problem with the library, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix.
GitHub Actions will run a few checks on each PR:
- Formatting, with
cargo fmt --all - Clippy lints, with
cargo clippy -- -D warnings - Tests, with
cargo testsandcargo test --release --examples
Tests on examples can be quite expensive to compile and run, don't hesitate to not run those locally before creating a PR.
Additionally, benchmarks are available to ensure your PR doesn't introduce regressions. They are not run in actions, you are encouraged to run them locally on the main branch then on your branch to check for any improvement.