Created
January 30, 2012 20:52
-
-
Save cbrammer/1706616 to your computer and use it in GitHub Desktop.
Commit Message
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Commit Message Format: | |
[fixes #<ticket number from pivotal tracker>] Subject | |
Detailed description | |
- item one | |
- item two | |
rb: Who did the code review for this commit | |
qa: notes to qa on how to test, good notes here make all the difference | |
## Commit Message Example: | |
[fixes #3] Capitalized, short (50 chars or less) summary | |
More detailed explanatory text, if necessary. 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. You can write your body to have multiple paragraphs and lists. | |
Further paragraphs come after blank lines. | |
- Bullet points are okay, too | |
- Write your commit message in the present tense: "Fixes bug" and not "Fixed bug." | |
rb: Frodo Baggins | |
qa: Notes to qa, this can also include multiple paragraphs and lists |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment