Skip to content

Commit

Permalink
docs: Tox environments and labels (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
lengau authored Mar 1, 2023
1 parent c0ccfda commit 7f8ff19
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions HACKING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,26 @@ If you'd like to run the tests with a newer version of Python, you can pass a sp

tox -e test-py310

Tox environments and labels
###########################

We group tox environments with the following labels:

* ``format``: Runs all code formatters with auto-fixing
* ``type``: Runs all type checkers
* ``lint``: Runs all linters (including type checkers)
* ``unit-tests``: Runs unit tests in Python versions on supported LTS's + latest
* ``integration-tests``: Same as above but for integration tests
* ``tests``: The union of ``unit-tests`` and ``integration-tests``

For each of these, you can see which environments will be run with ``tox list``. For example:

tox list -m lint

You can also see all the environments by simply running ``tox list``

Running ``tox run -m format`` and ``tox run -m lint`` before committing code is recommended.

.. _Black: https://black.readthedocs.io
.. _`Canonical contributor licence agreement`: http://www.ubuntu.com/legal/contributors/
.. _deadsnakes: https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa
Expand Down

0 comments on commit 7f8ff19

Please sign in to comment.