git提交注释规范

git 提交注释规范

git commit -m ‘type: (scope:) subject’
(body)

  • type 必需,用于说明 commit 的类别,只允许使用下面8个标识,并且为小写

    • br: 此项特别针对bug号,用于向测试反馈bug列表的bug修改情况
    • feat:新功能(feature)
    • fix:修补bug
    • docs:文档(documentation)
    • style: 格式(不影响代码运行的变动,空白、格式、缺少符号等)
    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    • test:增加测试
    • chore:构建过程、辅助工具、gitignore、库(如文档生成)等的变动
    • pref: 改进性能的变更
    • revert: feat(pencil): add ‘graphiteWidth’ option (撤销之前的commit)
  • scope 可选, 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

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

  • body 可选,部分是对本次 commit 的详细描述,可以分成多行。