openstack/hacking
Code Issues Proposed changes

Take advantage of RST formatting for links

Browse Source 
Use sphinx/rst for better links.

Change-Id: I6aa22f30e0e49d461eb8b2f745d3366a008a6030
This commit is contained in:
Joe Gordon 2015-05-23 15:45:42 -07:00
parent 9c20ad8503
commit a9a5e1d859
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
HACKING.rst
View File

@ -1,3 +1,5 @@
.. _StyleGuide:
OpenStack Style Guidelines OpenStack Style Guidelines
========================== ==========================
@ -12,10 +14,11 @@ more maintainable.
Step 0 Step 0
------ ------
- Step 1: Read http://www.python.org/dev/peps/pep-0008/ - Step 1: Read `pep8`_
- Step 2: Read http://www.python.org/dev/peps/pep-0008/ again - Step 2: Read `pep8`_ again
- Step 3: Read on - Step 3: Read on
.. _`pep8`: http://www.python.org/dev/peps/pep-0008/
General General
------- -------

8
README.rst
View File

@ -1,8 +1,7 @@
Introduction Introduction
============ ============
hacking is a set of flake8 plugins that test and enforce the `OpenStack hacking is a set of flake8 plugins that test and enforce the :ref:`StyleGuide`.
Style Guidlines <http://docs.openstack.org/developer/hacking>`_.
Hacking pins its dependencies, as a new release of some dependency can break 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 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 - The check must already have community support. We do not want to dictate
style, only enforce it. style, only enforce it.
- The canonical source of the OpenStack Style Guidelines is - The canonical source of the OpenStack Style Guidelines is :ref:`StyleGuide`,
`HACKING.rst and hacking just enforces
<http://docs.openstack.org/developer/hacking>`_, and hacking just enforces
them; so when adding a new check, it must be in ``HACKING.rst`` them; so when adding a new check, it must be in ``HACKING.rst``
- False negatives are ok, but false positives are not - False negatives are ok, but false positives are not
- Cannot be project specific, project specific checks should be `Local Checks`_ - Cannot be project specific, project specific checks should be `Local Checks`_