Skip to content

Commit 168398f

Browse files
committed
docs: add code coverage documentation
1 parent 1a232d0 commit 168398f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/code-coverage.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Code coverage
2+
3+
This project uses [Kover](https://github.com/Kotlin/kotlinx-kover) tool for generating code coverage metrics.
4+
To run the code coverage report for the whole codebase, run `./gradlew koverHtmlReport` and open the HTML report at `WordPress/build/reports/kover/html/index.html`.
5+
6+
## Coverage exclusions
7+
8+
To get more precise results of the metrics, some classes are excluded from code coverage calculations. Those classes are e.g. Dagger/Hilt generated code, Acitivies, Fragments, databinding etc. A complete list of exclusions is available in the `config/gradle/code_coverage.gradle` file.
9+
10+
## Codecov
11+
12+
We also have `Codecov` integration for getting reports on each PR and observing trends. See [the dashboard](https://app.codecov.io/github/wordpress-mobile/WordPress-Android/) to get more insights.

0 commit comments

Comments
 (0)