Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (21 loc) · 644 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 644 Bytes

Contributing to kroot

Thanks for contributing to kroot.

Development setup

git clone https://github.com/AnonJon/kroot
cd kroot
cargo build --workspace

Run tests

cargo test --workspace

Adding a new analyzer

  1. Create a file in crates/analyzers/src/analyzers/.
  2. Implement the Analyzer trait.
  3. Register the analyzer in crates/analyzers/src/registry.rs.
  4. Add tests under crates/analyzers/tests/.

Pull requests

  1. Keep changes focused and include tests when possible.
  2. Run cargo test --workspace before opening a PR.
  3. Describe the problem and solution clearly in the PR description.