This guide is meant for people wishing to contribute to this open-source project. For more information on contributing, see CONTRIBUTING.
You need at least Rust 1.75.0 to build this project's code and run the tests. You can install Rust from the official website.
If you already have a version of Rust installed via rustup but it's too old, you can update by running
rustup updateIn order to run rustfmt, you will need a Nightly Rust toolset. If you do not have one installed, you can install one via rustup by running
rustup toolchain install nightlyIf you already have one installed but it was too old, it was probably updated earlier when you ran rustup update 😉
just is a command-line tool to run scripts, a bit like npm's scripts. It's written in Rust.
This project includes a justfile that makes it easier to run the various tools used for development. To install just via cargo, simply run
cargo install justIf you have cargo-binstall, it'll probably be faster to use it instead:
cargo binstall justYou can also install it via various methods.
If you want to run tests with coverage locally, you'll need to install cargo-tarpaulin, a code coverage tool for Rust. You can install it via cargo:
cargo install cargo-tarpaulinYou can also install it via cargo-binstall:
cargo binstall cargo-tarpaulinIn order to run all tests, you can use
just testAny new feature or bug fix would need new tests to validate. Make sure all tests pass before submitting a PR.
Before submitting a PR, make sure rustfmt and clippy are happy. To tidy up your code before committing, simply run
just tidyRequired checks will not pass if either of those report issues.
This project's code coverage settings are pretty stringent and require 100% coverage (NDLR: ...or will someday). To validate this locally, you can run
just tarpaulinMake sure coverage is at the required level before submitting a PR.
If any part of this documentation is unclear, please open a new issue, so it can be fixed.