senlin-tempest-plugin/HACKING.rst
chenpengzi a9d2135f2e Update OpenStack Style Commandments address
Change-Id: Ifdfb8fd319ae34c26f94d053530cf0005d34be84
2018-02-02 11:31:16 +08:00

19 lines
702 B
ReStructuredText

Senlin Style Commandments
=========================
- Step 1: Read the OpenStack Style Commandments
https://docs.openstack.org/hacking/latest/
- Step 2: Read on
Senlin Specific Commandments
----------------------------
- [S318] Use assertion ``assertIsNone(A)`` instead of ``assertEqual(A, None)``
or ``assertEqual(None, A)``.
- [S319] Use ``jsonutils`` functions rather than using the ``json`` package
directly.
- [S320] Default arguments of a method should not be mutable.
- [S321] The api_version decorator has to be the first decorator on a method.
- [S322] LOG.warn is deprecated. Enforce use of LOG.warning.
- [S323] Use assertTrue(...) rather than assertEqual(True, ...).