From 936f32d3de468db8daf853155ddd5c6b191af60c Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 16 Jan 2007 22:53:28 -0800 Subject: git-commit: document log message formatting convention Take it from the tutorial, since not everybody necessarily reads it. Signed-off-by: Junio C Hamano --- Documentation/git-commit.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'Documentation/git-commit.txt') diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 6139386ad..9c8435306 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -218,6 +218,12 @@ refuses to run when given pathnames (but see `-i` option). DISCUSSION ---------- +Though not required, it's a good idea to begin the commit message +with a single short (less than 50 character) line summarizing the +change, followed by a blank line and then a more thorough description. +Tools that turn commits into email, for example, use the first line +on the Subject: line and the rest of the commit in the body. + include::i18n.txt[] ENVIRONMENT VARIABLES -- cgit v1.2.1