diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d161f45d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# 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. + +```shell +git clone https://github.com/dandavison/delta/ +cd delta +cargo build +``` + +### Useful Commands + +- Build release version: + + ```shell + cargo build --release + ``` + +- Run Clippy: + + ```shell + cargo clippy + ``` + +- Run all tests: + + ```shell + make test + ``` + +- Check to see if there are code formatting issues + + ```shell + cargo fmt -- --check + ``` + +- Format the code in the project + + ```shell + cargo fmt + ```