diff options
author | Marco Ieni <11428655+MarcoIeni@users.noreply.github.com> | 2020-11-21 02:14:50 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-20 20:14:50 -0500 |
commit | 248b1a7e185c123ecbbfdefa31a46d572ee40d7d (patch) | |
tree | bdc4a448e0280fd17ca05b7a125381753b0a0f6d /CONTRIBUTING.md | |
parent | 02dc6e053e72cd3cd5195e10d286c11509463a96 (diff) |
Create CONTRIBUTING.md (#385)
* Create CONTRIBUTING.md
* Update CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 50 |
1 files changed, 50 insertions, 0 deletions
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 + ``` |