Contributing

Get Started

This is a Rust project, so rustup is the best place to start.

This is a pure rust project, so only cargo is needed.

cargo check to analyze the current package and report errors.
cargo build to compile the current package.
cargo clippy to catch common mistakes and improve code.
cargo test to run unit tests.
cargo bench to run benchmark tests.

Useful tips:

Check/Build/Test/Clippy all code: cargo <cmd> --tests --benches --examples
Test specific function: cargo test tests::it::services::fs

Test

Copy .env.example to local, change needed test suite values.

cargo test