zun/HACKING.rst
root 5f2a016ea3 update higgins with zun
All contents mentioning higgins are updated to zun
using below 3 patterns:
:%s/higgins/zun/g
:%s/HIGGINS/ZUN/g
:%s/Higgins/Zun/g

Co-Authored-By: Hongbin Lu <hongbin.lu@huawei.com>

Change-Id: I33a979aa01421524c1cff6fb5cc2b4023bf1fe84
2016-06-08 22:21:34 -05:00

24 lines
1009 B
ReStructuredText

Zun Style Commandments
======================
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
Zun Specific Commandments
-------------------------
- [M302] Change assertEqual(A is not None) by optimal assert like
assertIsNotNone(A).
- [M310] timeutils.utcnow() wrapper must be used instead of direct calls to
datetime.datetime.utcnow() to make it easy to override its return value.
- [M316] Change assertTrue(isinstance(A, B)) by optimal assert like
assertIsInstance(A, B).
- [M318] Change assertEqual(A, None) or assertEqual(None, A) by optimal assert
like assertIsNone(A)
- [M322] Method's default argument shouldn't be mutable.
- [M323] Change assertEqual(True, A) or assertEqual(False, A) by optimal assert
like assertTrue(A) or assertFalse(A)
- [M336] Must use a dict comprehension instead of a dict constructor
with a sequence of key-value pairs.
- [M338] Use assertIn/NotIn(A, B) rather than assertEqual(A in B, True/False).
- [M339] Don't use xrange()