tacker/HACKING.rst
Sridhar Ramaswamy 492eba6c4a Cleanup Tacker docs and introduce tox doc test
Deep cleaning of tacker doc/source dir by removing all references
to Neutron, remove non-applicable doc files and various other
fixes and references to Tacker urls. Introduce fixed up HACKING and
CONTRIBUTING docs.

Also add tox 'docs' test run and enable it by default

Change-Id: I90c48eeb3724adb3de3431f1f5464c5200dad071
2015-10-19 19:15:13 +00:00

20 lines
684 B
ReStructuredText

Tacker Style Commandments
=========================
- Step 1: Read the OpenStack Style Commandments
http://docs.openstack.org/developer/hacking/
- Step 2: Read on
Tacker Specific Commandments
----------------------------
- [N320] Validate that LOG messages, except debug ones, have translations
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.