From 1152edd9dffdcb6d3ce0548b213b05c02b683694 Mon Sep 17 00:00:00 2001 From: Rick Harris Date: Wed, 29 Aug 2012 18:16:47 +0000 Subject: [PATCH] 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 --- HACKING.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/HACKING.rst b/HACKING.rst index 96805b4d8..52dc38bf8 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