rosenpass/CONTRIBUTING.md

Contributing to Rosenpass

Common operations

Apply code formatting

Format rust code:

cargo fmt

Format rust code in markdown files:

./format_rust_code.sh --mode fix

Spawn a development environment with nix

nix develop .#fullEnv

You need to install this nix package manager first.

Run our test

Make sure to increase the stack size available; some of our cryptography operations require a lot of stack memory.

RUST_MIN_STACK=8388608 cargo test --workspace --all-features

Generate coverage reports

Keep in mind that many of Rosenpass' tests are doctests, so to get an accurate read on our code coverage, you have to include doctests:

./coverage_report.sh