举例:
一个好的commit message应该是下面这样1
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 consequences 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
六条注意事项:
-
第一行为主题行,一句简要总结,与正文用空行隔
-
主题行建议字数50字以内,最多72个字
可以利用vim来实现72字符自动换行,只需要在~/.vimrc中添加下面这一行2
autocmd Filetype gitcommit setlocal spell textwidth=72 -
主题行首字母大写,不要句号结尾
-
主题行用祈使句
-
正文每行不得超过72个字符
-
正文要写清楚:是什么、为什么、怎么做