Skip to content

Commit

Permalink
Recommend release build in CONTRIBUTING.org
Browse files Browse the repository at this point in the history
  • Loading branch information
dandavison committed Dec 5, 2020
1 parent d0b5262 commit beb700f
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,17 @@ This is no different than other Rust projects.
```shell
git clone https://github.com/dandavison/delta/
cd delta
cargo build
cargo build --release
```

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

### Useful Commands

- Build release version:
- Run all tests:

```shell
cargo build --release
make test
```

- Run Clippy:
Expand All @@ -31,12 +33,6 @@ cargo build
cargo clippy
```

- Run all tests:

```shell
make test
```

- Check to see if there are code formatting issues

```shell
Expand All @@ -48,3 +44,9 @@ cargo build
```shell
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.

0 comments on commit beb700f

Please sign in to comment.