diff options
| -rw-r--r-- | Documentation/git-commit.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 6139386ad7..9c84353068 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 |