Skip to content

Commit

Permalink
Fix tox instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Scienfitz committed Dec 2, 2023
1 parent 86cc88f commit 8d3f1c0
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,23 @@ we recommend the following workflow:

1. Optional but recommended to prevent complaints from our CI pipeline: Test your code.

Testing against a single python can be achieved via `tox -e <version>`. For instance:
```bash
tox -e py311
There are several test environments you can run via `tox`, each corresponding to a
[developer tool](#developer-tools) in a certain Python version. You can see all
available environments via `tox list`.

For instance, running all code tests in Python 3.11 can be achieved via:
```console
tox -e fulltest-py311
```

If you want to challenge your machine, you can run all version tests in parallel via:
```bash
If you want to challenge your machine, you can run all checks in all Python versions
in parallel via:
```console
tox -p
```

This can be considered the ultimate one-stop check to make sure your code is ready
for merge.

1. Push the updated branch back to your fork:
```console
Expand Down

0 comments on commit 8d3f1c0

Please sign in to comment.