Skip to content

Commit

Permalink
Document running the tests and inspecting coverage
Browse files Browse the repository at this point in the history
Signed-off-by: Nir Soffer <nsoffer@redhat.com>
  • Loading branch information
nirs committed Jul 30, 2023
1 parent bf1eaee commit a19593e
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/devel-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,30 @@ enough resources:

That's all! You are ready to submit your first pull request!

## Running the tests

To run all unit tests run:

```
make test
```

To run only part of the test suite you can use one of the `test-*`
targets, for example:

```
make test-vrg-vr
```

To open an HTML coverage report in the default browser run:

```
make coverage
```

The coverage report depends on the tests ran before inspecting the
coverage.

## Setting up the `drenv` tool

*Ramen* uses the `drenv` tool to build a development environment
Expand Down

0 comments on commit a19593e

Please sign in to comment.