openstack/hacking
Code Issues Proposed changes

Add example to versioning section of README

Browse Source 
Clarify the versioning documentation by providing an example.

Change-Id: I8bf7a24248c0da890af76eb61a90bac7dd976721
This commit is contained in:
Joe Gordon 2015-05-23 15:13:25 -07:00
parent 6db5a221c9
commit 3a5f20f380
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -41,12 +41,15 @@ the process and remove the extra burden from human reviewers.
Versioning
==========
hacking uses the major.minor.maintenance release notation, where maintenance
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
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.
For example a project can depend on ``hacking>=0.10.0,<0.11.0``, and can know
that ``0.10.1`` will not fail in places where ``0.10.0`` passed.
Adding additional checks
========================