Skip to content

docs: refine CONTRIBUTING.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
msclock merged 1 commit into from
Jan 4, 2024
Merged

docs: refine CONTRIBUTING.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down