Skip to content

Commit 158a59a

Browse files
committed
add instructions for testing to readme
1 parent 5cc20c2 commit 158a59a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,12 @@ To ensure that the coding and formatting guidelines are followed, install [ruff]
211211

212212
To ensure that any types are correct, install [mypy](https://github.com/python/mypy) and run `mypy safeeyes`.
213213

214-
The last three checks are also run in CI, so a PR must pass all the tests for it to be mmerged.
214+
To ensure that the tests still pass, install [pytest](https://docs.pytest.org/en/stable/) and run `pytest`.
215+
216+
The last four checks are also run in CI, so a PR must pass all the tests for it to be mmerged.
217+
218+
It is also possible to use dependency groups to install the needed dependencies. When using a new enough version of pip, run `pip install --group types` to install all dependencies to run the type check.
219+
The available dependency groups can be found in the `pyproject.toml` file.
215220

216221
## How to Release?
217222

0 commit comments

Comments
 (0)