diff --git a/HACKING.rst b/HACKING.rst index e83743b..d0e0309 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,3 +1,5 @@ +.. _StyleGuide: + OpenStack Style Guidelines ========================== @@ -12,10 +14,11 @@ more maintainable. Step 0 ------ -- Step 1: Read http://www.python.org/dev/peps/pep-0008/ -- Step 2: Read http://www.python.org/dev/peps/pep-0008/ again +- Step 1: Read `pep8`_ +- Step 2: Read `pep8`_ again - Step 3: Read on +.. _`pep8`: http://www.python.org/dev/peps/pep-0008/ General ------- diff --git a/README.rst b/README.rst index f41a09a..7bf8af1 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,7 @@ Introduction ============ -hacking is a set of flake8 plugins that test and enforce the `OpenStack -Style Guidlines `_. +hacking is a set of flake8 plugins that test and enforce the :ref:`StyleGuide`. 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 @@ -77,9 +76,8 @@ Requirements ------------ - The check must already have community support. We do not want to dictate style, only enforce it. -- The canonical source of the OpenStack Style Guidelines is - `HACKING.rst - `_, and hacking just enforces +- The canonical source of the OpenStack Style Guidelines is :ref:`StyleGuide`, + 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`_