mirror of
https://github.com/git/git
synced 2024-08-27 11:39:22 +00:00
Merge branch 'xz/commit-title-soft-limit-doc'
Doc update. * xz/commit-title-soft-limit-doc: doc: correct the 50 characters soft limit (+)
This commit is contained in:
commit
0bc6bff9d5
|
@ -137,10 +137,10 @@ which will automatically notice any modified (but not new) files, add
|
|||
them to the index, and commit, all in one step.
|
||||
|
||||
A note on commit messages: 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. The text up to the first blank line in a commit
|
||||
message is treated as the commit title, and that title is used
|
||||
begin the commit message with a single short (no more than 50
|
||||
characters) line summarizing the change, followed by a blank line and
|
||||
then a more thorough description. The text up to the first blank line in
|
||||
a commit message is treated as the commit title, and that title is used
|
||||
throughout Git. For example, linkgit:git-format-patch[1] turns a
|
||||
commit into email, and it uses the title on the Subject line and the
|
||||
rest of the commit in the body.
|
||||
|
|
|
@ -1122,7 +1122,7 @@ choosing "Stage Hunk For Commit").
|
|||
=== Creating good commit messages
|
||||
|
||||
Though not required, it's a good idea to begin the commit message
|
||||
with a single short (less than 50 character) line summarizing the
|
||||
with a single short (no more than 50 characters) line summarizing the
|
||||
change, followed by a blank line and then a more thorough
|
||||
description. The text up to the first blank line in a commit
|
||||
message is treated as the commit title, and that title is used
|
||||
|
|
|
@ -412,7 +412,7 @@ There are some conventions that l10n contributors must follow:
|
|||
- Do not use non-ASCII characters in the subject of a commit.
|
||||
|
||||
- The length of commit subject (first line of the commit log) should
|
||||
be less than 50 characters, and the length of other lines of the
|
||||
be no more than 50 characters, and the length of other lines of the
|
||||
commit log should be no more than 72 characters.
|
||||
|
||||
- Add "Signed-off-by" trailer to your commit log, like other commits
|
||||
|
|
Loading…
Reference in a new issue