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
This commit is contained in:
Rick Harris 2012-08-29 18:16:47 +00:00
parent 96f90e5ad4
commit 1152edd9df

View File

@ -235,6 +235,10 @@ readable. Follow these guidelines:
description of the change, not just a reference to a bug or description of the change, not just a reference to a bug or
blueprint. It must be followed by a single blank line. 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 Following your brief summary, provide a more detailed description of
the patch, manually wrapping the text at 72 characters. This the patch, manually wrapping the text at 72 characters. This
description should provide enough detail that one does not have to description should provide enough detail that one does not have to