Added coverage in README

nomad-coe · Jun 5, 2024 · b58c9ca · b58c9ca
1 parent f3b2b43
commit b58c9ca
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -45,6 +45,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.txt
 *.cover
 *.py,cover
 .hypothesis/

diff --git a/README.md b/README.md
@@ -42,12 +42,11 @@ python -m pytest -sv
 
 where the `-s` and `-v` options toggle the output verbosity.
 
-Our CI/CD pipeline produces a more comprehensive test report using `coverage` and `coveralls` packages.
-To emulate this locally, perform:
+Our CI/CD pipeline produces a more comprehensive test report using `coverage` and `coveralls` packages. We suggest you to generate your own coverage reports locally by doing:
 
 ```sh
 pip install coverage coveralls
-python -m coverage run -m pytest -sv
+python -m pytest --cov=src
 ```
 
 ## Development