Git commit message 规范

参照Angularjs的commit message 格式,

如:

fix(jenkins): reset baseUrl in protractor conf
Commit 22b817e changed the url
used by protractor in all docs tests to prepend "build/docs", which
was already set to the `baseUrl` in `protractor-jenkins.conf`. This
commit just changes the protractor config's `baseUrl` to adapt
to the changes in the spec files.
Closes #9783

格式如下:

(): 
<空行>

<空行>

主要包含三部分:

  1. 标题:可以在页面中预览,包含type, scope, subject
  2. 内容详情
  3. 结尾

Type(类型)

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style:格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test: 增加测试
  • chore:构建过程或辅助工具的变动

Scope(范围)

用来说明本次Commit影响的范围,即简要说明修改会涉及的部分。这个本来是选填项,但AngularJS实际项目中可以看出基本上也成了必填项。

Subject(主题)

用来简要描述本次改动,概述就好了,因为后面还会在Body里给出具体信息。并且最好遵循下面三条:

  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 首字母不要大写
  • 结尾不用句号.

Body(详细说明)

里的内容是对上面subject里内容的展开,在此做更加详尽的描述,内容里应该包含修改动机和修改前后对比。

Footer(脚注)

footer里的主要放置不兼容变更Issue关闭的信息。

你可能感兴趣的:(Git commit message 规范)