Skip to content

Commit f6a6610

Browse files
authored
Contributing (#110)
* documenting test coverage reports
1 parent f5d6071 commit f6a6610

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,17 @@ Now you can invoke the integration test suite as follows:
177177
pytest integration/ --cert path/to/service_acct.json --apikey path/to/apikey.txt
178178
```
179179

180+
### Test Coverage
181+
182+
To review the test coverage, run `pytest` with the `--cov` flag. To view a detailed line by line
183+
coverage, use
184+
```bash
185+
pytest --cov --cov-report html
186+
```
187+
and point your browser to
188+
`file:///<dir>/htmlcov/index.html` (where `dir` is the location from which the report was created).
189+
190+
180191
### Testing in Different Environments
181192

182193
Sometimes we want to run unit tests in multiple environments (e.g. different Python versions), and

0 commit comments

Comments
 (0)