Contributors Guide
We want to make contributing to SpatialBench as easy and transparent as possible. If you have suggestions to improve this contribution guide, feel free to open an issue in GitHub.
Our Development Process¶
To contribute, please find an existing issue or open a new one. Claiming the issue you are working on helps us better track progress.
Pull Requests¶
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 related documentation.
- Ensure the standard tests and conformance tests are passing.
- Ensure your code follows Rust best practices and addresses all lints from clippy.
- Open your pull request and wait for a review and approval.
Filing Issues¶
When opening a new issue, please follow the issue template and provide as many details as possible, including a reproducible example if applicable.
Coding Style¶
Follow standard Rust formatting guidelines. For idiomatic code style, consult Effective Rust.
License¶
By contributing to SpatialBench, you agree that your contributions will be licensed
under the LICENSE
file in the root directory of this source tree.