From 5a6b18a979ddda3f9cd8ff774397a9ad02bdc20f Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Wed, 9 Dec 2015 14:04:01 -0500 Subject: [PATCH] CONTRIBUTING: Document the Fixes header. Document the use of the Fixes header to refer to a commit that introduced a bug being fixed. Signed-off-by: Russell Bryant Acked-by: Joe Stringer --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97ab9cb84..1e1d573c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -231,6 +231,16 @@ Examples of common tags follow. in old change log entries. (They are obsolete because they do not tell the reader what bug tracker is referred to.) + Fixes: 63bc9fb1c69f (“packets: Reorder CS_* flags to remove gap.”) + + If you would like to record which commit introduced a bug being fixed, + you may do that with a “Fixes” header. This assists in determining + which OVS releases have the bug, so the patch can be applied to all + affected versions. The easiest way to generate the header in the + proper format is with this git command: + + git log -1 --pretty=format:"Fixes: %h (\"%s\")" --abbrev=12 COMMIT_REF + Developer's Certificate of Origin --------------------------------- -- 2.20.1