Update README.md on linters
authorMitja Nikolaus <mitja@fairphone.com>
Thu, 29 Nov 2018 13:58:55 +0000 (14:58 +0100)
committerMitja Nikolaus <mitja@fairphone.com>
Fri, 7 Dec 2018 12:54:22 +0000 (12:54 +0000)
Issue: HIC-276
Change-Id: I8ce2b175e54260320c6ca5544145c61a66236bb8

README.md

index f6d4c4e..7e62ab3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -160,6 +160,10 @@ To generate HTML coverage reports (saved to `htmlcov/`):
 
 #### Linters and Formatters
 
+To run the linters (flake8 and pylint) on all files:
+
+    (hiccupenv) $ tox -e linters
+
 To run flake8 on only the diff with upstream:
 
     (hiccupenv) $ git diff origin/master ./**/*py | flake8 --diff
@@ -189,12 +193,6 @@ set to true:
 
     (hiccupenv) $ git config --bool flake8.strict true
 
-There is also a lint check included with tox (`tox -e linters`) but it is very
-noisy at the moment since the codebase is not clean yet. Since you are already
-validating the changes you are making with the git pre-commit hook, you are
-all set to submit your change.
-
-
 ### Branching structure
 
 The `production` branch reflects the codebase currently running on the production server. New