Skip to content

Commit

Permalink
Update contributing doc regarding tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Huy-Ngo committed Mar 21, 2024
1 parent c7b75e9 commit 4bad4f0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@ If you want to run all tests without install `dev` requirements, you can install
pip install -e .['test']
```

To run tests, use `test` command with `setup.py`:
To run tests, use `pytest`:

```shell
python setup.py test
pytest
```

Or, use `pytest` with customize options like:

```shell
pytest tests/test_openapi.py --maxfail=1
pytest tests/extensions/openapi/ --maxfail=1
```

Furthermore, you can use `tox` to run tests with different environment configs to verify compatibility.
Expand Down Expand Up @@ -82,8 +82,8 @@ In `dev` requirements, some modules related to code style are already included:
Please make sure your contribution will using the same styling tools. You can use following commands to apply them to your contributions:

```shell
black --verbose sanic_openapi tests
isort --recursive sanic_openapi tests
black --verbose sanic_ext tests
isort --recursive sanic_ext tests
```

## Build Document
Expand Down

0 comments on commit 4bad4f0

Please sign in to comment.