8e699a24c9
We need to release a bug fix release, 0.5.5, which cannot contain any new checks. Currently there are several open bugs, and more testing that is needed before we are ready to start adding new checks. Since we are pinning hacking versions to <0.6, we can releases, every time we add new checks we need to rev the minor release number. But since we don't have extensive enough testing in this repository I am not confident in our ability to add new working checks. So until we are ready to cut 0.6 disable the check. Change-Id: I84582fb41d859166395ba150c10e5a859a528950 |
||
|---|---|---|
| doc/source | ||
| hacking | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .testr.conf | ||
| CONTRIBUTING.rst | ||
| HACKING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
Introduction
hacking is a set of flake8 plugins that test and enforce the OpenStack Style Commandments, HACKING.rst.
Versioning
hacking uses the major.minor.maintenance release notation, where maintenance releases cannot contain new checks. This way projects can gate on hacking by pinning on the major.minor number while accepting maintenance updates without being concerned that a new version will break the gate with a new check.
Adding additional checks
Each check is a pep8 plugin so read
https://github.com/jcrocholl/pep8/blob/master/docs/developer.rst#contribute
Requirements
- The canonical source of the OpenStack Style Commandments is HACKING.rst, and hacking just enforces them; so when adding a new check, it must be in HACKING.rst
- False negatives are ok, but false positives are not
- Cannot be project specific, project specific checks should be Local Checks
- Docstring tests
- Registered as entry_points in setup.cfg
- Error code must be in the relevant
Hxxxgroup
Local Checks
hacking supports having local changes in a source tree. They can be configured to run in two different ways. They can be registered individually, or with a factory function.
For individual registration, put a comma separated list of pep8 compatible check functions into the hacking section of tox.ini. Like
[hacking] local-check = nova.tests.hacking.bad_code_is_terrible
Alternately, you can specify the location of a callable that will be called at registration time and will be passed the registration function. The callable should expect to call the passed in function on everything if wants to register. Such as:
[hacking] local-check-factory = nova.tests.hacking.factory