Skip to content

Commit 10a6b52

Browse files
authored
Update README.md
1 parent 76d0497 commit 10a6b52

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ There aren't any visualization tools built-in but you can always store artifacts
2121

2222
## Quick install
2323

24+
You can install commitstat locally to test your parsing patterns, but commit statuses will only be created when run in CI.
25+
2426
```console
2527
$ curl https://rg.gosu.cc/dropseed/commitstat/master/install.sh | bash -s -- -b $HOME/bin
2628
```
@@ -54,7 +56,7 @@ jobs:
5456
5557
## Example uses
5658
57-
### mypy
59+
### [mypy](http://mypy-lang.org/)
5860
5961
Parse the mypy imprecision text report (lower number is better).
6062
@@ -63,7 +65,7 @@ $ mypy src --ignore-missing-imports --no-incremental --txt-report ./.reports/myp
6365
$ commitstat .reports/mypy/index.txt --regex "\| Total\s*\|\s*([\d\.]+%)" --goal decrease --name mypy
6466
```
6567

66-
### pytest with pytest-cov
68+
### [pytest](https://docs.pytest.org/en/latest/) with [pytest-cov](https://github.com/pytest-dev/pytest-cov)
6769

6870
Parse the pytest-cov default HTML report for the total coverage percentage.
6971

0 commit comments

Comments
 (0)