Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 1021 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (16 loc) · 1021 Bytes
Raw

Guidelines

  • All code submitted to RingChannel via pull requests is assumed to be licensed under the MIT.
  • Every code change must be covered by unit tests, use cargo-llvm-cov to generate the code coverage report:
    • cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
  • Besides cargo test, make sure Clippy and rustfmt checks also pass before submitting a pull request:
    • cargo clippy --all-targets -- -D warnings
    • cargo fmt --all -- --check
  • Follow rustsec.org advisories when introducing new dependencies, use cargo-audit to verify:
    • cargo audit -D