openstack/swift
Code Issues Proposed changes

Add documentation about flake8+hacking.

Browse Source 
- Fixes bug 1201431.

Change-Id: If025a41caf3a629b9efb4d67c53c423796d37a91
This commit is contained in:
Chmouel Boudjnah
2013-07-15 17:14:16 +02:00
parent 8aba2d602e
commit 18a0813d9b
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/development_guidelines.rst
View File

@@ -6,7 +6,7 @@ Development Guidelines
Coding Guidelines Coding Guidelines
----------------- -----------------
For the most part we try to follow PEP 8 guidelines which can be viewed For the most part we try to follow PEP 8 guidelines which can be viewed
here: http://www.python.org/dev/peps/pep-0008/ here: http://www.python.org/dev/peps/pep-0008/
There is a useful pep8 command line tool for checking files for pep8 There is a useful pep8 command line tool for checking files for pep8
@@ -17,7 +17,7 @@ Testing Guidelines
------------------ ------------------
Swift has a comprehensive suite of tests that are run on all submitted code, Swift has a comprehensive suite of tests that are run on all submitted code,
and it is recommended that developers execute the tests themselves to and it is recommended that developers execute the tests themselves to
catch regressions early. Developers are also expected to keep the catch regressions early. Developers are also expected to keep the
test suite up-to-date with any submitted code changes. test suite up-to-date with any submitted code changes.
@@ -51,11 +51,29 @@ To execute the unit tests:
- `tox -e pep8,py26` - `tox -e pep8,py26`
------------
Coding Style
------------
Swift use flake8 with the OpenStack `hacking`_ module to enforce
coding style.
Install flake8 and hacking with pip or by the packages of your
Operating System.
It is advised to integrate flake8+hacking with your editor to get it
automated and not get `caught` by Jenkins.
For example for Vim the `syntastic`_ plugin can do this for you.
.. _`hacking`: https://pypi.python.org/pypi/hacking
.. _`syntastic`: https://github.com/scrooloose/syntastic
------------------------ ------------------------
Documentation Guidelines Documentation Guidelines
------------------------ ------------------------
The documentation in docstrings should follow the PEP 257 conventions The documentation in docstrings should follow the PEP 257 conventions
(as mentioned in the PEP 8 guidelines). (as mentioned in the PEP 8 guidelines).
More specifically: More specifically:
@@ -80,7 +98,7 @@ License and Copyright
--------------------- ---------------------
You can have the following copyright and license statement at You can have the following copyright and license statement at
the top of each source file. Copyright assignment is optional. the top of each source file. Copyright assignment is optional.
New files should contain the current year. Substantial updates can have New files should contain the current year. Substantial updates can have
another year added, and date ranges are not needed.:: another year added, and date ranges are not needed.::