Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (14 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

28 lines (14 loc) · 1.26 KB

Contributing to bnf

👋 welcome! And thanks for taking time to contribute!

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Questions

Please feel free to raise issues to ask questions or report bugs. If you'd like to open a PR but want to touch bases first, feel free to raise an issue then too.

Opening PRs

Good PR comments go a long way. It means a lot (and really helps) when you take the time to explain why your PR is doing what it does.

Mutation testing

We use cargo-mutants to find gaps in the test suite (code that runs but isn’t asserted on). Optional, not required for PRs.

  • Install: cargo install cargo-mutants
  • Run: cargo mutants (or cargo mutants --all-features). Use -f 'src/foo.rs' to limit scope, --list to see mutants without running tests.
  • Results: missed = mutation not caught by any test (add a test or #[mutants::skip]); caught = good; unviable = didn’t compile; timeout = add #[mutants::skip] to that function.

Thanks again!