aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2016-06-01 09:55:43 +1200
committerAldo Cortesi <aldo@nullcube.com>2016-06-01 09:55:43 +1200
commit06703542037d1c84b0dcb60c6d1c500a0d189e93 (patch)
tree534e52152cd70a5545aa834622ffe7331ef55348 /README.rst
parentd98582664d8f234fe6a2c805f02d47686243379f (diff)
downloadmitmproxy-06703542037d1c84b0dcb60c6d1c500a0d189e93.tar.gz
mitmproxy-06703542037d1c84b0dcb60c6d1c500a0d189e93.tar.bz2
mitmproxy-06703542037d1c84b0dcb60c6d1c500a0d189e93.zip
Style guides in README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 1228f318..421366cc 100644
--- a/README.rst
+++ b/README.rst
@@ -99,6 +99,15 @@ After installation, you can render the documentation like this:
The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds
the documentation when a change is detected.
+Style
+-----
+
+Keeping to a consistent code style throughout the project makes it easier to
+contribute and collaborate. Please stick to the guidelines in
+[PEP8](https://www.python.org/dev/peps/pep-0008/p) and the [Google Python Style
+Guide](https://google.github.io/styleguide/pyguide.html) unless there's a very
+good reason not to.
+
.. |mitmproxy_site| image:: https://shields.mitmproxy.org/api/https%3A%2F%2F-mitmproxy.org-blue.svg