Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (19 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.18 KB

Contribution Guide

Getting started

This is a Rust project, so rustup is the best place to start.

This is a pure rust project, so only cargo is needed.

  • cargo check to analyze the current package and report errors.
  • cargo build to compile the current package.
  • cargo clippy to catch common mistakes and improve code.
  • cargo test to run unit tests (see notes on snapshot testing below).
  • cargo bench to run benchmark tests.

Useful tips:

  • Check/Build/Test/Clippy all code: cargo <cmd> --all-targets --workspace
  • Test specific function: cargo test multiple_local_parent

Snapshot Testing

The core fastrace crate uses Insta Snapshot testing locally. Be aware that to properly run tests, you will ideally need to have cargo-insta installed in your local rust toolchain to be able to review changes to tests where the snapshots have changed, and thus prevent CI from breaking in such instances.

For more information on cargo-insta read the official documentation here.

For features, questions, or discussions

Please open a new issue.