document coverage workflow
@@ -30,6 +30,21 @@ looking for a place to get started!
[hw]: https://github.com/ZcashFoundation/zebra/labels/E-help-wanted
[gfi]: https://github.com/ZcashFoundation/zebra/labels/good%20first%20issue
+## Coverage Reports
+[coverage-reports]: #coverage-reports
+
+Zebra's CI currently generates coverage reports for every PR with rust's new
+source based coverage feature. The coverage reports are generated by the
+`coverage.yml` file.
+
+These reports are then saved as html and zipped up into a github action's
+artifact. These artifacts can be accessed on the `checks` tab of any PR, next
+to the "re-run jobs" button on the `Coverage (+nightly)` CI job's tab
+[example](https://github.com/ZcashFoundation/zebra/pull/1907/checks?check_run_id=2127676611).
+
+To access a report download and extract the zip artifact then open the top
+level `index.html`.
+
## Zebra RFCs
[zebra-rfcs]: #zebra-rfcs
@@ -62,4 +77,3 @@ with the PR number.
8. After the RFC is accepted, create an issue for the implementation of the
design, and update the RFC header and PR description with the implementation
issue number.
-
