Skip to content

Commit 6a5b649

Browse files
aspiersgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bdd478d commit 6a5b649

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Documentation/SubmittingPatches

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ Checklist (and a short version for the impatient):
99
- the first line of the commit message should be a short
1010
description (50 characters is the soft limit, see DISCUSSION
1111
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)
1220
- the body should provide a meaningful commit message, which:
1321
. explains the problem the change tries to solve, iow, what
1422
is wrong with the current code without the change.

0 commit comments

Comments
 (0)