aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2020-04-09 08:37:57 +0200
committerGitHub <noreply@github.com>2020-04-09 08:37:57 +0200
commit0d9e517c064ca3992fac83c3a1ec6e4284221e72 (patch)
treec1472652ee95cf8c41b91d544e89f3b0d64c0323 /README.rst
parent4d6886a0f4ebbf6bc66b74fa548ff724ba2ad660 (diff)
parentb5e3f736c0c6654c3ef0d1f280a4eacdb5ca91de (diff)
downloadmitmproxy-0d9e517c064ca3992fac83c3a1ec6e4284221e72.tar.gz
mitmproxy-0d9e517c064ca3992fac83c3a1ec6e4284221e72.tar.bz2
mitmproxy-0d9e517c064ca3992fac83c3a1ec6e4284221e72.zip
Merge pull request #3767 from mitmproxy/fix-ci
re-add missing CI steps and fix linting
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 5ceda97c..124e4765 100644
--- a/README.rst
+++ b/README.rst
@@ -95,12 +95,13 @@ 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 py # runs Python tests
+
+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 +110,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.
@@ -138,11 +139,12 @@ good reason not to.
This is automatically enforced on every PR. If we detect a linting error, the
PR checks will fail and block merging. You can run our lint checks yourself
-with the following command:
+with the following commands:
.. code-block:: bash
- tox -e lint
+ tox -e flake8
+ tox -e mypy # checks static types
.. |mitmproxy_site| image:: https://shields.mitmproxy.org/badge/https%3A%2F%2F-mitmproxy.org-blue.svg