diff options
| author | Graham <graham.hayes@hp.com> | 2013-10-03 16:36:06 +0100 |
|---|---|---|
| committer | Graham <graham.hayes@hp.com> | 2013-10-07 14:00:13 +0100 |
| commit | 09cb5b95595e2cecc86b1d1f950d45929a20e0a3 (patch) | |
| tree | b0e844ea25a1afbcf8c53a583b5a2ad83607759f | |
| parent | 6698b14a42479f1e37b08443ace2f39d25268b72 (diff) | |
| download | designate-09cb5b95595e2cecc86b1d1f950d45929a20e0a3.tar.gz | |
Added info on flake8 to docs
Added information about flake8 to the documetation, in the getting involved section
Change-Id: I99374ce0e64ad27c074bc7d8c4ac39acecfc99d9
| -rw-r--r-- | doc/source/getting-involved.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/source/getting-involved.rst b/doc/source/getting-involved.rst index d449e24b..d42ce8c7 100644 --- a/doc/source/getting-involved.rst +++ b/doc/source/getting-involved.rst @@ -35,7 +35,20 @@ Branch, work, & submit: # submit git-review +Coding Standards +---------------- +Designate uses the OpenStack flake8 coding standards guidelines. +These are stricter than pep8, and are run by gerrit on every commit. +You can use tox to check your code locally by running + + .. code-block:: shell-session + + # For just flake8 tests + tox -e flake8 + # For tests + flake8 + tox + .. _Gerrit workflow: https://wiki.openstack.org/wiki/Gerrit_Workflow .. _blueprint: https://blueprints.launchpad.net/designate .. _bug: https://bugs.launchpad.net/designate |