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:
@ -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.
|
them to the index, and commit, all in one step.
|
||||||
|
|
||||||
A note on commit messages: Though not required, it's a good idea to
|
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)
|
begin the commit message with a single short (no more than 50
|
||||||
line summarizing the change, followed by a blank line and then a more
|
characters) line summarizing the change, followed by a blank line and
|
||||||
thorough description. The text up to the first blank line in a commit
|
then a more thorough description. The text up to the first blank line in
|
||||||
message is treated as the commit title, and that title is used
|
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
|
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
|
commit into email, and it uses the title on the Subject line and the
|
||||||
rest of the commit in the body.
|
rest of the commit in the body.
|
||||||
|
@ -1122,7 +1122,7 @@ choosing "Stage Hunk For Commit").
|
|||||||
=== Creating good commit messages
|
=== Creating good commit messages
|
||||||
|
|
||||||
Though not required, it's a good idea to begin the commit message
|
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
|
change, followed by a blank line and then a more thorough
|
||||||
description. The text up to the first blank line in a commit
|
description. The text up to the first blank line in a commit
|
||||||
message is treated as the commit title, and that title is used
|
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.
|
- Do not use non-ASCII characters in the subject of a commit.
|
||||||
|
|
||||||
- The length of commit subject (first line of the commit log) should
|
- 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.
|
commit log should be no more than 72 characters.
|
||||||
|
|
||||||
- Add "Signed-off-by" trailer to your commit log, like other commits
|
- Add "Signed-off-by" trailer to your commit log, like other commits
|
||||||
|
Reference in New Issue
Block a user