Skip to content

Commit c999861

Browse files
authored
feat: add badge for code coverage (#722)
1 parent b59e19a commit c999861

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,15 @@ backports structure with a small typing example.
149149
- Replaces Flake8, isort, pyupgrade, yesqa, pycln, and dozens of plugins
150150
- Includes spell checking
151151
- One of several popular licenses
152-
- An pylint nox target can be used to run pylint, which integrated GHA
152+
- A pylint nox target can be used to run pylint, which integrated GHA
153153
annotations
154154
- A ReadTheDocs-ready Sphinx or MkDocs `docs/` folder and `docs`
155155
dependency-group
156156
- A `tests/` folder and pytest `test` dependency-group
157157
- A dev group for `uv run` integration
158158
- A noxfile is included with a few common targets
159159
- A README
160+
- Code coverage reporting with automatic uploads to Codecov after tests run
160161

161162
#### For developers:
162163

{{cookiecutter.project_name}}/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
{%- if cookiecutter.org | lower == "scikit-hep" %}
1212
[![Scikit-HEP][sk-badge]](https://scikit-hep.org/) {%- endif %}
1313

14+
[![Coverage][coverage-badge]][coverage-link]
15+
1416
{%- if cookiecutter.docs == "sphinx" %}
1517

1618
<!-- SPHINX-START -->
@@ -31,5 +33,7 @@
3133
{%- if cookiecutter.org | lower == "scikit-hep" %}
3234
[sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
3335
{%- endif %}
36+
[coverage-badge]: https://codecov.io/{{cookiecutter.__ci}}/{{cookiecutter.org}}/{{cookiecutter.project_name}}/branch/main/graph/badge.svg
37+
[coverage-link]: https://codecov.io/{{cookiecutter.__ci}}/{{cookiecutter.org}}/{{cookiecutter.project_name}}
3438

3539
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)