From a719a2f49f3ac2584b31a19e6d3de36373ca8608 Mon Sep 17 00:00:00 2001 From: Pavel Tikhomirov Date: Fri, 18 Dec 2020 12:03:17 +0300 Subject: [PATCH] CONTRIBUTING.md: add component prefix to the subject example If one will do "git log --oneline", it is quite easy to see that we don't begin subject lines with a capital letter. We start subjects with component prefixes where components (mostly) are lowercase. So let's fix it in contribution guide not to mislead newcomers. Signed-off-by: Pavel Tikhomirov --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d803d020..96972296e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -126,6 +126,19 @@ If your change address an issue listed in GitHub, please use `Fixes:` tag with t The `Fixes:` tags should be put at the end of the detailed description. +Please add a prefix to your commit subject line describing the part of the +project your change is related to. This can be either the name of the file or +directory you changed, or just a general word. If your patch is touching +multiple components you may separate prefixes with "/"-es. Here are some good +examples of subject lines from git log: + +``` +criu-ns: Convert to python3 style print() syntax +compel: Calculate sh_addr if not provided by linker +style: Enforce kernel style -Wstrict-prototypes +rpc/libcriu: Add lsm-profile option +``` + 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. @@ -203,7 +216,7 @@ commit message. To append such line to a commit you already made, use ``` From: Random J Developer - Subject: [PATCH] Short patch description + Subject: [PATCH] component: Short patch description Long patch description (could be skipped if patch is trivial enough)