contributing: don't reference issues in commit first line
Commits named "Fix #XXX" make it pretty complicated to figure out exactly what the commit is doing from the shortlog. A better place for issue references is in the extended commit message.
This commit is contained in:
parent
267eb02c31
commit
b0972a94c3
|
@ -76,8 +76,7 @@ Please strive to write good commit messages. Here's some guidelines to follow:
|
||||||
|
|
||||||
The first line should be limited to 50 characters and should be a sentence that
|
The first line should be limited to 50 characters and should be a sentence that
|
||||||
completes the thought [When applied, this commit will...] *"Implement
|
completes the thought [When applied, this commit will...] *"Implement
|
||||||
cmd_move"* or *"Fix #742"* or *"Improve performance of arrange_windows on ARM"*
|
cmd_move"* or *"Improve performance of arrange_windows on ARM"* or similar.
|
||||||
or similar.
|
|
||||||
|
|
||||||
The subsequent lines should be separated from the subject line by a single
|
The subsequent lines should be separated from the subject line by a single
|
||||||
blank line, and include optional details. In this you can give justification
|
blank line, and include optional details. In this you can give justification
|
||||||
|
|
Loading…
Reference in New Issue