mirror of
https://github.com/dandavison/delta.git
synced 2024-10-05 04:17:21 +03:00
Create CONTRIBUTING.md (#385)
* Create CONTRIBUTING.md * Update CONTRIBUTING.md
This commit is contained in:
parent
02dc6e053e
commit
248b1a7e18
50
CONTRIBUTING.md
Normal file
50
CONTRIBUTING.md
Normal 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
|
||||
```
|
Loading…
Reference in New Issue
Block a user