delta/CONTRIBUTING.md

Contribution guidelines

First off, thank you for considering contributing to delta.

If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.

Developing

Set up

This is no different than other Rust projects.

git clone https://github.com/dandavison/delta/
cd delta
cargo build --release

The executable is then at ./target/release/delta.

Useful Commands

• Run all tests:

  make test
  

• Run Clippy:

  cargo clippy
  

• Check to see if there are code formatting issues

  cargo fmt -- --check
  

• Format the code in the project

  cargo fmt
  

• Debug build

A "debug" build can be built using cargo build and ./target/debug/delta. This is faster to compile, but has much worse performance than the release build.