Contributing

Setup

• Set up the git pre-commit hook:

  pip install pre-commit
  pre-commit install
  

• Install the nightly release of Rust:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly
  

Note

If you are new to Rust, see the Reference section of the Rust page of the OCP Software Development Handbook.

Benchmarks

cargo bench

Note

We can consider the criterion crate for additional benchmarks.

Tasks

• Add an indicator