SubmittingPatches: Cite the 50 char subject limit
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Wed, 28 Jul 2010 14:11:25 +0000 (14:11 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 28 Jul 2010 20:51:33 +0000 (13:51 -0700)
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>
Documentation/SubmittingPatches

index 2e18f6b440adad6598e4bda1921122b1f86c276a..ece3c77482b3ff006b973f1ed90b708e26556862 100644 (file)
@@ -7,7 +7,8 @@ Checklist (and a short version for the impatient):
          before committing
        - do not check in commented out code or unneeded files
        - 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:
                - uses the imperative, present tense: "change",
                  not "changed" or "changes".