summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorRick Harris <rconradharris@gmail.com>2012-08-29 18:16:47 +0000
committerRick Harris <rconradharris@gmail.com>2012-08-29 18:48:43 +0000
commit701549ce0d1b76e37d5ca80f677db037edef48d0 (patch)
tree139915996e75f07da42193fa604a6555a4ec1aa9 /HACKING.rst
parent20c6bb6c9000fa0d193f688b668f5f3eeda8fb05 (diff)
downloadnova-701549ce0d1b76e37d5ca80f677db037edef48d0.tar.gz
hacking: Add driver prefix recommendation.
Prefixing the commit message's first line with the driver makes it easier for reviewers, at a glance, to find reviews that relate to their area of expertise as well as improving the overall readability of the git history. Change-Id: I376d2cdb5dc344717fb7749a80e33ee88603e68c
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 96805b4d80..52dc38bf88 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -235,6 +235,10 @@ readable. Follow these guidelines:
description of the change, not just a reference to a bug or
blueprint. It must be followed by a single blank line.
+ If the change relates to a specific driver (libvirt, xenapi, qpid, etc...),
+ begin the first line of the commit message with the driver name, lowercased,
+ followed by a colon.
+
Following your brief summary, provide a more detailed description of
the patch, manually wrapping the text at 72 characters. This
description should provide enough detail that one does not have to