Skip to content

Commit

Permalink
Update code coverage command
Browse files Browse the repository at this point in the history
  • Loading branch information
Grimes authored and solana-grimes committed May 29, 2018
1 parent 26153d9 commit c64cfb7
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,11 @@ Run the test suite:
$ cargo test
```

To emulate all the tests that will run on a Pull Request, run:
```bash
$ ./ci/run-local.sh
```

Debugging
---

Expand Down Expand Up @@ -169,8 +174,10 @@ Code coverage
To generate code coverage statistics, run kcov via Docker:

```bash
$ docker run -it --rm --security-opt seccomp=unconfined --volume "$PWD:/volume" elmtai/docker-rust-kcov
$ ./ci/coverage.sh
```
The coverage report will be written to `./target/cov/index.html`


Why coverage? While most see coverage as a code quality metric, we see it primarily as a developer
productivity metric. When a developer makes a change to the codebase, presumably it's a *solution* to
Expand Down

0 comments on commit c64cfb7

Please sign in to comment.