Git commit 规范

373 阅读1分钟

一个好的 Git commit 要素齐全,格式工整,一眼便能知晓提交人完成的工作。

比如下图是开源项目 element-plus 的提交记录,我们可以清晰的看到谁干了什么类型的工作,主要的对象是什么,主题是什么。

image.png

Git commit规范是一种标准化的提交信息格式,通常由以下几部分组成:

类型(Type)

用于说明本次提交的类型,例如新增功能、修复Bug等。常用的类型有:

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

范围(Scope)

用于说明本次提交影响的范围,例如某个模块或功能。

主题(Subject)

用于简要描述本次提交的内容,尽量简洁明了,不超过50个字符。

标准的Git commit

一个标准的Git commit信息格式如下:

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

例如:

feat(login): add remember me feature

在实际使用中,可以使用工具来帮助规范Git commit信息格式,例如使用Commitizen、Gitmoji。同时,也可以结合代码检查工具和自动化构建工具来进行Git commit信息的检查和自动化生成。