Contributing

Contributing to vrd

A summary of the project's contributing guide; the guide in the repository is the reference.

What every pull request passes

cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test
cargo build --no-default-features

The contributing guide also recommends cargo audit, cargo run --example all to run every example, and the Cortex-M check cargo check --target thumbv7em-none-eabihf --no-default-features.

  • New behaviour comes with new tests in the same pull request, and every file stays at or above 98% region coverage (cargo llvm-cov).
  • A new dependency needs a reason in the pull request.
  • The pull request body has ## Summary and ## Test Plan sections, and the title stays under 70 characters.

Signed commits and conventions

Sign every commit (git commit -S). Commit messages follow Conventional Commits, with ! for a breaking change, and each commit holds one logical change. Report a bug as an issue with a few lines that reproduce it, the expected and actual output, and your Rust version. Security problems go through the private channel on the security page. The full guide is CONTRIBUTING.md.

Licence of contributions

By contributing you agree that your work is dual-licensed under Apache-2.0 or MIT, matching the crate.

Improving this website

The source of vrdlib.com is in the vrdlib.github.io repository. Report a mistake on the site there, or through the contact page.