undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SubmittingPatches: Cite the 50 char subject limit

Browse Source 
Change the SubmittingPatches recommendations to mention the 50
character soft limit on patch subject lines. 50 characters is the soft
limit mentioned in git-commit(1) and gittutorial(7), it's also the
point at which Gitweb, GitHub and various other Git front ends start
abbreviating the commit message.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2010-07-28 14:11:25 +00:00 committed by Junio C Hamano
parent 6a58696f5b
commit 43e331e6ee
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/SubmittingPatches
View File

@ -7,7 +7,8 @@ Checklist (and a short version for the impatient):
before committing before committing
- do not check in commented out code or unneeded files - do not check in commented out code or unneeded files
- the first line of the commit message should be a short - the first line of the commit message should be a short
description and should skip the full stop description (50 characters is the soft limit, see DISCUSSION
in git-commit(1)), and should skip the full stop
- the body should provide a meaningful commit message, which: - the body should provide a meaningful commit message, which:
- uses the imperative, present tense: "change", - uses the imperative, present tense: "change",
not "changed" or "changes". not "changed" or "changes".