Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 530 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 530 Bytes

Contributing

Setup

  • Install Rust from https://rustup.rs/
  • clone this repo
  • Run cargo test to verify everything is working as expected

Development

  • Make changes
  • Use cargo check --tests to get quick compiler feedback
    • Using cargo check will only check non-test files
  • Use cargo test to test functionality
    • Use the enable_tracing() helper function to get test output

Linting

  • Run cargo fmt --check to see if there are formatting issues
  • Run cargo clippy to get best practice feedback