summaryrefslogtreecommitdiffstats
path: root/DEVELOP.rst
diff options
context:
space:
mode:
Diffstat (limited to 'DEVELOP.rst')
-rw-r--r--DEVELOP.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/DEVELOP.rst b/DEVELOP.rst
index 0c4dedf3..dc9157f6 100644
--- a/DEVELOP.rst
+++ b/DEVELOP.rst
@@ -155,3 +155,18 @@ To see stdout/stderr, use the following command:
$ behave --no-capture
+
+PEP8 checks
+-----------
+
+When you submit a PR, the changeset is checked for pep8 compliance using
+`pep8radius <https://github.com/hayd/pep8radius>`_. If you see a build failing because
+of these checks, install pep8radius and apply style fixes:
+
+::
+
+ $ pip install pep8radius
+ $ pep8radius --docformatter --diff # view a diff of proposed fixes
+ $ pep8radius --docformatter --in-place # apply the fixes
+
+Then commit and push the fixes.