diff --git a/HACKING.rst b/HACKING.rst index 64a6ddc..d0ad1e3 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,11 +1,10 @@ -OpenStack Style Commandments -============================ +OpenStack Style Guidelines +========================== - Step 1: Read http://www.python.org/dev/peps/pep-0008/ - Step 2: Read http://www.python.org/dev/peps/pep-0008/ again - Step 3: Read on - General ------- - Put two newlines between top-level code (funcs, classes, etc) @@ -320,3 +319,8 @@ and how to split up commits into a series of changes, consult the project wiki: https://wiki.openstack.org/GitCommitMessages + +Futher Reading +-------------- + + http://google-styleguide.googlecode.com/svn/trunk/pyguide.html diff --git a/README.rst b/README.rst index e333035..29d1720 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,16 @@ Introduction hacking is a set of flake8 plugins that test and enforce the OpenStack Style Commandments, `HACKING.rst `_. +Origin +====== + +Most of the additional style guidelines that OpenStack has taken on came from +the Google Python Style Guide. + + http://google-styleguide.googlecode.com/svn/trunk/pyguide.html + +Since then, a few more OpenStack specific ones have been added or modified. + Versioning ==========