Skip to content

Commit

Permalink
docs: add local development nox docs (#342)
Browse files Browse the repository at this point in the history
* docs: add local development nox docs

* docs: add local development nox docs

* small unit tests uses local py env
  • Loading branch information
dhercher committed Nov 4, 2021
1 parent b74e03e commit 80d26c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ python -m pip install --upgrade pip
python -m pip install .
```

## Local Testing

This project uses [Nox](https://nox.thea.codes/en/stable/) for managing tests. Install nox to your local environment and it will handle creating the virtual environments required for each test.

To run our local testing suite, use:

`python3 -m nox --envdir ~/dvt/envs/ -s unit_small blacken lint`

## Conventional Commits

This project uses [Conventional
Expand Down
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def unit(session):
)


@nox.session(python=DEFAULT_PYTHON_VERSION, venv_backend="venv")
@nox.session(venv_backend="venv")
def unit_small(session):
unit(session)

Expand Down

0 comments on commit 80d26c6

Please sign in to comment.