aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorThomas Kriechbaumer <thomas@kriechbaumer.name>2019-12-31 16:03:45 +0100
committerThomas Kriechbaumer <thomas@kriechbaumer.name>2019-12-31 16:27:22 +0100
commit40925181e9d64c727f75e89acf0205bb4b87bb3a (patch)
treea61834dd85444d50ce04cd1aa157875dbfc03967 /README.rst
parent7b638f1b6b543ec5e23170217a42ca0e5c421992 (diff)
downloadmitmproxy-40925181e9d64c727f75e89acf0205bb4b87bb3a.tar.gz
mitmproxy-40925181e9d64c727f75e89acf0205bb4b87bb3a.tar.bz2
mitmproxy-40925181e9d64c727f75e89acf0205bb4b87bb3a.zip
re-add missing CI steps and fix linting
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 79766a4e..cfcc3e7f 100644
--- a/README.rst
+++ b/README.rst
@@ -95,12 +95,15 @@ Testing
-------
If you've followed the procedure above, you already have all the development
-requirements installed, and you can run the full test suite with tox_:
+requirements installed, and you can run the basic test suite with tox_:
.. code-block:: bash
- tox -e py # runs Python tests
- tox -e lint # checks code style
+ tox -e py37 # runs Python tests
+ tox -e flake8 # checks code style style
+ tox -e mypy # checks static types
+
+Our CI system has additional tox environments that are run on every pull request and branch on GitHub.
For speedier testing, we recommend you run `pytest`_ directly on individual test files or folders:
@@ -109,7 +112,7 @@ For speedier testing, we recommend you run `pytest`_ directly on individual test
cd test/mitmproxy/addons
pytest --cov mitmproxy.addons.anticache --cov-report term-missing --looponfail test_anticache.py
-Pytest does not check the code style, so you want to run ``tox -e lint`` again before committing.
+Pytest does not check the code style, so you want to run ``tox -e flake8`` again before committing.
Please ensure that all patches are accompanied by matching changes in the test
suite. The project tries to maintain 100% test coverage and enforces this strictly for some parts of the codebase.