To improve the review of bug-fixes a standardized reference to the
bug-introducing commit, which the Fixes: tag provides, can make life
a lot simpler - and it allows some level of automation.

While strongly adviseable it is only recommended and not set to mandatory
notably as it is better *not* to reference a commit if unsure than to
reference a wrong commit.

Signed-off-by: Nicholas Mc Guire <[email protected]>
---
 CONTRIBUTING.md |    6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 40655ce..98c7527 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -39,6 +39,12 @@ Contribution Checklist
       your work" in https://www.kernel.org/doc/Documentation/SubmittingPatches
     - check with your employer when not working on your own!
 
+- add Fixes: to all bug-fix commits [*recommended*]
+    - the Fixes: tag format shall be:
+        Fixes: 12-byte-hash ("subject of bug-introducting commit")
+    - if you are unsure of the bug-introducting commit do *not* add a
+      Fixes: tag - no Fixes: tag is better than a wrong Fixes: tag.
+
 - post patches to mailing list [**required**]
     - use `git format-patch/send-email` if possible
     - send patches inline, do not append them
-- 
1.7.10.4

-- 
You received this message because you are subscribed to the Google Groups 
"Jailhouse" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to