diff --git a/HACKING.rst b/HACKING.rst index f81c0e3b..cdadac1d 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,4 +1,16 @@ cyborg Style Commandments =============================================== -Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ +If you haven't already done so read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ + +Before you commit your code run tox against your patch using the command. + + tox . + +If any of the tests fail correct the error and try again. If your code is valid Python +but not valid pep8 you may find autopep8 from pip useful. + +Once you submit a patch integration tests will run and those may fail, -1'ing your patch +you can make a gerrit comment 'recheck ci' if you have reviewed the logs from the jobs +by clicking on the job name in gerrit and concluded that the failure was spurious or otherwise +not related to your patch. If problems persist contact people on #openstack-cyborg or #openstack-infra.