aboutsummaryrefslogtreecommitdiffstats
path: root/tests/README.md
diff options
context:
space:
mode:
authorGravatar scragly <[email protected]>2019-11-30 22:42:51 +1000
committerGravatar GitHub <[email protected]>2019-11-30 22:42:51 +1000
commit51f1055753faca9e054f85aff8bbace4a89fb166 (patch)
tree5f4afa6c4d907e5c0a4d1abaf0f7162a090d2fd5 /tests/README.md
parentUpdate bot/cogs/moderation/modlog.py (diff)
parentMerge pull request #621 from python-discord/duck_pond (diff)
Merge branch 'master' into message-edit-hyperlink
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
index 6ab9bc93e..d052de2f6 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -15,6 +15,7 @@ We are using the following modules and packages for our unit tests:
To ensure the results you obtain on your personal machine are comparable to those generated in the Azure pipeline, please make sure to run your tests with the virtual environment defined by our [Pipfile](/Pipfile). To run your tests with `pipenv`, we've provided two "scripts" shortcuts:
- `pipenv run test` will run `unittest` with `coverage.py`
+- `pipenv run test path/to/test.py` will run a specific test.
- `pipenv run report` will generate a coverage report of the tests you've run with `pipenv run test`. If you append the `-m` flag to this command, the report will include the lines and branches not covered by tests in addition to the test coverage report.
If you want a coverage report, make sure to run the tests with `pipenv run test` *first*.