aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2012-12-16 19:35:59 +0000
committerJunio C Hamano <gitster@pobox.com>2012-12-16 18:30:50 -0800
commit6a5b6498837e43d1904f12eed9d47b47250680f1 (patch)
tree775e3602c78f428abf45f365aef6e77066f3ad8a
parentbdd478d620034dc6517aea940f5dc6b88f780c04 (diff)
downloadgit-6a5b6498837e43d1904f12eed9d47b47250680f1.tar.gz
git-6a5b6498837e43d1904f12eed9d47b47250680f1.tar.xz
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>
-rw-r--r--Documentation/SubmittingPatches8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 0dbf2c984..c107cb169 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -9,6 +9,14 @@ Checklist (and a short version for the impatient):
- the first line of the commit message should be a short
description (50 characters is the soft limit, see DISCUSSION
in git-commit(1)), and should skip the full stop
+ - it is also conventional in most cases to prefix the
+ first line with "area: " where the area is a filename
+ or identifier for the general area of the code being
+ modified, e.g.
+ . archive: ustar header checksum is computed unsigned
+ . git-cherry-pick.txt: clarify the use of revision range notation
+ (if in doubt which identifier to use, run "git log --no-merges"
+ on the files you are modifying to see the current conventions)
- the body should provide a meaningful commit message, which:
. explains the problem the change tries to solve, iow, what
is wrong with the current code without the change.