Skip to content

Instantly share code, notes, and snippets.

@nelsonsar
Created August 29, 2013 22:05
Show Gist options
  • Save nelsonsar/6383991 to your computer and use it in GitHub Desktop.
Save nelsonsar/6383991 to your computer and use it in GitHub Desktop.
Good commit message template. This was extracted from http://blog.dynamic50.com/2009/11/26/moving-your-git-repos-and-all-branches-to-a-new-remote-repository/ and ALL credits should go for him.
Here’s a model Git commit message:
Capitalized, short (50 chars or less) summary
More detailed explanatory text, if necessary. 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.
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, preceded by a
single space, with blank lines in between, but conventions vary here
- Use a hanging indent
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment