diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -99,6 +99,13 @@ 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`_ and the `Google Style Guide`_ 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 @@ -145,3 +152,5 @@ the documentation when a change is detected. .. _Sphinx: http://sphinx-doc.org/ .. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild .. _issue_tracker: https://github.com/mitmproxy/mitmproxy/issues +.. _PEP8: https://www.python.org/dev/peps/pep-0008 +.. _Google Style Guide: https://google.github.io/styleguide/pyguide.html |