Git(三)代码提交规范

本文介绍前端框架Angular提倡的 Git Commit Message 规范。


(): 



每次提交包含消息头header、消息体body和消息尾footer,其中消息头内容必须。
每次提交信息不超过100个字符。

1. 消息头

消息头格式指定为提交类型type、作用域scope和主题subject

1.1 提交类型

  • build:修改构建系统或者外部依赖项
  • ci:修改 CI 配置文件或脚本
  • docs:修改文档
  • feat:增加新特性
  • fix:修复 Bug
  • pref:性能优化
  • refactor:代码重构
  • style:代码风格、代码规范修改
  • test:测试代码修改
  • revert:撤销上一次的 commit 提交
  • chore:构建过程或辅助工具变动

1.2 作用域

说明改动的范围。

1.3 主题

对本次修改的简单描述,注意以下原则:

  • 使用命令式,现在时态:改变,不是已改变,也不是改变了
  • 不要大写首字母
  • 不在末尾添加句号

2. 消息体

和主题设置类似,使用命令式、现在时态,应该包含修改的动机以及和之前行为的对比。

3. 消息尾

3.1 重大变化

所有重大的更改应以单词BREAKING CHANGE:跟上空格或两个换行符开头,在消息尾的开头以区块的方式声明。剩下的提交信息是对改动的描述,理由和迁移说明。

3.2 关闭问题

已关闭的问题应在消息尾中单独一行列出,并以Closes关键字作为前缀,如:Closes #XXX,或关闭多个问题:Closes #XXX, #XXX, #XXX

你可能感兴趣的:(Git(三)代码提交规范)