commit message格式:

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

type(必须)

用于说明git commit的类别,只允许使用下面的标识。

  1. feat:新功能(feature)
  2. fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG
    1. fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
    2. to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
  3. docs:文档(documentation)
  4. style:格式(不影响代码运行的变动)
  5. refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  6. perf:优化相关,比如提升性能、体验
  7. test:增加测试
  8. chore:构建过程或辅助工具的变动
  9. revert:回滚到上一个版本
  10. merge:代码合并
  11. sync:同步主线或分支的Bug

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject(必须)

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

建议使用中文(感觉中国人用中文描述问题能更清楚一些)。

  • 结尾不加句号或其他标点符号。
  • 根据以上规范git commit message将是如下的格式:
1
2
fix(DAO):用户查询缺少username属性 
feat(Controller):用户查询接口开发