-
Notifications
You must be signed in to change notification settings - Fork 0
Commit messages
Michal Hošna edited this page Jan 12, 2018
·
2 revisions
- Separate subject from body with a blank line
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why you have done something. In most cases, you can leave out details about how a change has been made.
- A properly formed git commit subject line should always be able to complete the following sentence
If applied, this commit will .... - Try to reference issues, or closem them (https://help.github.com/articles/closing-issues-using-keywords/)
Example:
AppBundle: Short (72 chars or less) summary (Fixes #21, see #32)
More detailed explanatory text. Wrap it to 72 characters. The blank
line separating the summary from the body is critical (unless you omit
the body entirely).
Write your commit message in the imperative: "Fix bug" and not "Fixed
bug" or "Fixes bug." This convention matches up with commit messages
generated by commands like git merge and git revert.
Further paragraphs come after blank lines.
- Bullet points are okay, too.
- Typically a hyphen or asterisk is used for the bullet, followed by a
single space. Use a hanging indent.
Development: