Isaku Yamahata 6461c84cb7 add HACKING.rst: style guide

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

2012-02-22 20:25:15 +09:00

Python version and libraries

Python 2.6+ As RHEL 6 adopted python 2.6, features only for 2.7+ should be avoided.
standard library + widely used library Basically widely used == OpenStack adopted As usual there are exceptions. gevents. Or python binding library for other component.

Coding style guide

pep8 As python is used, PEP8 is would be hopefully mandatory for http://www.python.org/dev/peps/pep-0008/
pylint Although pylint is useful for finding bugs, but pylint score not very important for now because we're still at early development stage.

Guidelines derived from Guido's Recommendations

Type	Public	Internal
Packages	lower_with_under
Modules	lower_with_under	_lower_with_under
Classes Exceptions	CapWords CapWords	_CapWords
Functions	lower_with_under()	_lower_with_under()
Global/Class Constants	CAPS_WITH_UNDER	_CAPS_WITH_UNDER
Global/Class Variables	lower_with_under	_lower_with_under
Instance Variables	lower_with_under	_lower_with_under (protected) or __lower_with_under (private)
Method Names Function/Method Parameters Local Variables	lower_with_under() lower_with_under lower_with_under	_lower_with_under() (protected) or __lower_with_under() (private)

OpenStack Nova style guide https://github.com/openstack/nova/blob/master/HACKING.rst