SubmittingPatches: add convention of prefixing commit messages
Conscientious newcomers to git development will read SubmittingPatches and CodingGuidelines, but could easily miss the convention of prefixing commit messages with a single word identifying the file or area the commit touches. Signed-off-by: Adam Spiers <git@adamspiers.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Adam Spiers committed
Dec 16, 2012 at 19:35 UTC
6a5b6498837e43d1904f12eed9d47b47250680f1
1 file changed
+8
Documentation/SubmittingPatches
+8
@@ -9,6 +9,14 @@ Checklist (and a short version for the impatient):
9
- the first line of the commit message should be a short
10
description (50 characters is the soft limit, see DISCUSSION
11
in git-commit(1)), and should skip the full stop
12
+ - it is also conventional in most cases to prefix the
13
+ first line with "area: " where the area is a filename
14
+ or identifier for the general area of the code being
15
+ modified, e.g.
16
+ . archive: ustar header checksum is computed unsigned
17
+ . git-cherry-pick.txt: clarify the use of revision range notation
18
+ (if in doubt which identifier to use, run "git log --no-merges"
19
+ on the files you are modifying to see the current conventions)
20
- the body should provide a meaningful commit message, which:
21
. explains the problem the change tries to solve, iow, what
22
is wrong with the current code without the change.