# hacking: OpenStack Hacking Guideline Enforcement

hacking is a set of flake8 plugins that test and enforce the OpenStack Style Guidelines.

Hacking pins its dependencies, as a new release of some dependency can break hacking based gating jobs. This is because new versions of dependencies can introduce new rules, or make existing rules stricter.

- Contributing: If you are a new contributor to Hacking please refer: So You Want to Contribute…

- User Documentation
  - OpenStack Style Guidelines
    - Step 0
    - General
    - Imports
    - Docstrings
    - Dictionaries/Lists
    - Calling Methods
    - Internationalization (i18n) Strings
    - Python 3.x compatibility
    - Creating Unit Tests
    - Unit Tests and assertRaises
    - OpenStack Trademark
    - OpenStack Licensing
    - Commit Messages
  - Using hacking
    - Introduction
    - Installation
    - Origin
    - Versioning
    - Adding additional checks
    - Enabling off-by-default checks
    - Local Checks

this page last updated: 2023-08-22 10:18:51

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug