Created
March 30, 2018 16:47
-
-
Save sujinleeme/26edc8d8ee96e5f93a8c00ecd6c4a42a to your computer and use it in GitHub Desktop.
commit message sample
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
feat: Summarize changes in around 50 characters or less | |
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 the commit 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); various tools like `log`, `shortlog` | |
and `rebase` can get confused if you run the two together. | |
Explain the problem that this commit is solving. Focus on why you | |
are making this change as opposed to how (the code explains that). | |
Are there side effects or other unintuitive consequenses of this | |
change? Here's the place to explain them. | |
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 | |
If you use an issue tracker, put references to them at the bottom, | |
like this: | |
Resolves: #123 | |
See also: #456, #789 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment