...
After the short summary line, you may continue the message with one or more paragraphs separated by an empty line, each line about 72 characters or less. The empty line after the short summary is necessary if you want to add more text since source control tools like git may send the log message as an email and use the first line up to an empty line as the email subject.
When submitting a commit with significant changes authored by another contributor, be sure to attribute such changes to the author in your commit comment.
| Code Block | ||||
|---|---|---|---|---|
| ||||
Short, one line summary (50 chars or less), not a paragraph More detailed explanatory text as necessary, patch attributions, and what platforms the commit has been tested on. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of an email and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); tools like rebase can get confused if you run the two together. This is an example of a second paragraph. The 'Author:' line is required if the commit represents code submitted by somebody who does not have commit permissions. The person doing the commit is implicitly the reviewer of the submitted code. The email address is optional but it is nice to have so the original author can be uniquely identified. It is OK for the committer to modify or cleanup the code and if done so, should be noted in the commit log. |
...