From 06703542037d1c84b0dcb60c6d1c500a0d189e93 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Wed, 1 Jun 2016 09:55:43 +1200 Subject: [PATCH] Style guides in README --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index 1228f318b..421366cc7 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