From 320c88e922c191f508e4fbf8e95809d30a3cc571 Mon Sep 17 00:00:00 2001 From: Mike Rapoport Date: Wed, 5 Aug 2020 16:20:10 +0300 Subject: [PATCH] CONTRIBUTING.md: clarify placement of Fixes: tags The description of the Fixes: tags could be misleading and may be understood as if "Fixes: " should be the commit summary. Add a sentence with explicit description of Fixme: tags placement. Reported-by: Otto Bittner Signed-off-by: Mike Rapoport --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d40f0014c..5d803d020 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,6 +124,8 @@ If your change address an issue listed in GitHub, please use `Fixes:` tag with t Fixes: #339 ``` +The `Fixes:` tags should be put at the end of the detailed description. + You may refer to [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) article for recommendations for good commit message.