[关闭]
@ttop5 2017-05-23T08:56:31.000000Z 字数 709 阅读 1179

Git commit messages规范


基本格式

  1. <type>(<scope>): <subject>

type表示提交类别,subject表示标题行,body表示主体描述内容。

示例: git commit -m "docs(README): XXXXXXXX"

(1) type

必填 用于说明commit的类型。

  • feat: 添加新特性
  • fix: 修复bug
  • docs: 仅仅修改了文档
  • style: 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
  • refactor: 代码重构,没有加新功能或者修复bug
  • perf: 对代码进性能行优化
  • test: 增加测试用例
  • chore: 改变构建流程、或者增加依赖库、工具等

(2) scope

可选 scope用于说明commit影响的范围,比如数据层、控制层、视图层或者目录甚至文件等等,视项目不同而不同。

(3) subject:

必填 subject是commit目的的简短描述,不超过50个字符。

  • 约定好commit message的语言,统一使用英文或者中文;
  • 最好以动词开头(如使用英文请使用第一人称现在时,并且第一个字母小写);
  • <scope>之后的冒号后面留一个英文输入法的空格
  • 结尾不加句号或其他标点符号;
  • 若此次commit是解决某个issue应该在行末尾注明并加链接,如:...(#101)

【参考文章】:

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注