From bbccfff13c05e654366138f1a9d31b1ee956c588 Mon Sep 17 00:00:00 2001 From: msclock Date: Thu, 4 Jan 2024 09:11:34 +0800 Subject: [PATCH] docs: refine CONTRIBUTING.md Signed-off-by: msclock --- .github/CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 06cdb4a..e02446d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -17,6 +17,7 @@ Python on your system, skipping ones that are not installed. You can also run specific jobs: ```console +$ nox -l # List available tasks $ nox -s lint # Lint only $ nox -s tests # Python tests $ nox -s docs -- serve # Build and serve the docs @@ -63,15 +64,29 @@ You can also/alternatively run `pre-commit run` (changes only) or Use pytest to run the unit checks: ```bash +pip install -e .[test] pytest ``` +or + +```bash +nox -s tests +``` + ## Coverage Use pytest-cov to generate coverage reports: ```bash -pytest --cov=pyauthorizer +pip install -e .[test] +pytest --cov +``` + +or + +```bash +nox -s tests -- --cov ``` ## Building docs