diff options
Diffstat (limited to 'HACKING.rst')
| -rw-r--r-- | HACKING.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 00000000..9b765901 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,27 @@ +Ceilometer Style Commandments +============================= + +- Step 1: Read the OpenStack Style Commandments + http://docs.openstack.org/developer/hacking/ +- Step 2: Read on + +Ceilometer Specific Commandments +-------------------------------- + +- [C301] LOG.warn() is not allowed. Use LOG.warning() +- [C302] Deprecated library function os.popen() + +Creating Unit Tests +------------------- +For every new feature, unit tests should be created that both test and +(implicitly) document the usage of said feature. If submitting a patch for a +bug that had no unit test, a new passing unit test should be added. If a +submitted bug fix does have a unit test, be sure to add a new one that fails +without the patch and passes with the patch. + +All unittest classes must ultimately inherit from testtools.TestCase. + +All setUp and tearDown methods must upcall using the super() method. +tearDown methods should be avoided and addCleanup calls should be preferred. +Never manually create tempfiles. Always use the tempfile fixtures from +the fixture library to ensure that they are cleaned up. |