Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-30 03:14:22 +00:00
Code Issues Projects Releases Wiki Activity

Style guides in README

Browse Source
This commit is contained in:
Aldo Cortesi 2016-06-01 09:55:43 +12:00
parent d98582664d
commit 0670354203
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.rst
View File

@ -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