summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorDaniel P. Berrange <berrange@redhat.com>2012-07-30 11:08:03 +0100
committerDaniel P. Berrange <berrange@redhat.com>2012-07-30 11:08:03 +0100
commit7047d854f13f25f306968aa1b068848eea67d71f (patch)
tree9269b2c041c88b5c9ec7b69cbdd811f1591f841c /HACKING.rst
parent90de9055355322f0c49366fe3001fe6f3cbe4b03 (diff)
downloadnova-7047d854f13f25f306968aa1b068848eea67d71f.tar.gz
Add a link from HACKING to wiki GitCommitMessages page
The HACKING file contains a short example of an effective commit message. For reasons for space, it cannot describe the rationale behind this example. It also does not have space to describe how to split up a patch into a series of commits. Add a link from the HACKING file to the wiki http://wiki.openstack.org/GitCommitMessages where further information can be found Change-Id: I34d44485486b623b11743106f09d5ef631d35888
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 2ebc58927b..85bad4d0d0 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -234,3 +234,9 @@ readable. Follow these guidelines:
message: a blank line followed by a 'Change-Id'. This is important
to correlate this commit with a specific review in Gerrit, and it
should not be modified.
+
+For further information on constructing high quality commit messages,
+and how to split up commits into a series of changes, consult the
+project wiki:
+
+ http://wiki.openstack.org/GitCommitMessages