Skip to content

Commit

Permalink
Add coveragepy as a dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
stefsmeets committed Jul 23, 2024
1 parent 66f24f7 commit ef86f2f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing guidelines

### Running tests

JANUS uses [pytest](https://docs.pytest.org/en/latest/) to run the tests. You can run the tests for yourself using:

```console
pytest
```

To check coverage:

```console
coverage run -m pytest
coverage report # to output to terminal
coverage html # to generate html report
```
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ homepage = "https://github.com/FormingWorlds/JANUS"
[project.optional-dependencies]
develop = [
"bump-my-version",
"coverage[toml]",
"pytest"
]
publishing = [
Expand All @@ -59,6 +60,10 @@ publishing = [
package-dir = {"janus" = "src/janus"}
include-package-data = true

[tool.coverage.run]
branch = true
source = ["janus"]

[tool.pytest.ini_options]
testpaths = ["tests"]

Expand Down

0 comments on commit ef86f2f

Please sign in to comment.