neutron-lib/HACKING.rst
Akihiro Motoki 90a8302231 Update the documentation link for doc migration
Change-Id: I7db258cc50373c5011b8f99b6f8971a08ca336f3
2017-07-20 15:46:41 +00:00

23 lines
942 B
ReStructuredText

neutron-lib Style Commandments
==============================
- Step 1: Read the OpenStack Style Commandments
https://docs.openstack.org/hacking/latest/
- Step 2: Read on
Neutron Library Specific Commandments
-------------------------------------
- [N521] Validate that jsonutils module is used instead of json
- [N524] Prevent use of deprecated contextlib.nested.
- [N525] Python 3: Do not use xrange.
- [N526] Python 3: do not use basestring.
- [N527] Python 3: do not use dict.iteritems.
- [N529] Method's default argument shouldn't be mutable
- [N530] No importing of neutron; should be ignored in neutron itself
- [N532] Validate that LOG.warning is used instead of LOG.warn. The latter is deprecated.
- [N534] Exception messages should be translated
- [N535] Usage of Python eventlet module not allowed
- [N536] Use assertIsNone/assertIsNotNone rather than assertEqual/assertIs to check None values.
- [N537] Don't translate logs.