From 850371adbedd2cf0d06b41faff66be1f4de33c8f Mon Sep 17 00:00:00 2001 From: Bartosz Sokorski Date: Mon, 30 Sep 2024 19:40:02 +0200 Subject: [PATCH] Add info about getting test coverage in contribution guide --- docs/contributing.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/contributing.md b/docs/contributing.md index 3d6d430b1fa..995e899a4a7 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -152,6 +152,14 @@ poetry install poetry run pytest ``` +{{% note %}} +If you want to see the coverage stats after the tests are complete, use: + +```bash +poetry run pytest --cov=src/poetry --cov-report term +``` +{{% /note %}} + When you contribute to Poetry, automated tools will be run to make sure your code is suitable to be merged. Besides pytest, you will need to make sure your code typechecks properly using [mypy](http://mypy-lang.org/):