Create CONTRIBUTING.md (#385)

* Create CONTRIBUTING.md

* Update CONTRIBUTING.md
This commit is contained in:
Marco Ieni 2020-11-21 02:14:50 +01:00 committed by GitHub
parent 02dc6e053e
commit 248b1a7e18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

50
CONTRIBUTING.md Normal file
View File

@ -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
```