我的 Git 提交规范

357 阅读2分钟

Git 提交规范是指在使用 Git 进行代码管理时,对提交信息进行规范化和统一化的方式。通过遵守一定的规范来记录代码变化,团队成员能够更好地了解代码的变化,方便代码审核和维护。因此,采用良好的提交规范对于团队协作非常重要。

通常情况下,我的一个完整的 Git 提交包括三部分:提交类型提交范围提交描述

规范格式

下面是一个标准的 Git 提交规范格式:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

类型

其中,<type> 表示提交的类型,包括以下几种:

  • feat:新功能
  • fix:修复 bug
  • docs:文档相关变更
  • style:代码风格相关变更
  • refactor:重构代码
  • test:测试相关变更
  • chore:构建、工具等其他非代码变更
  • perf:改进性能
  • revert:撤销先前的提交

<scope> 表示本次提交的范围,可以是具体的文件、模块、功能等。

<description> 是对本次提交的简要描述,应该简短,不超过 50 个字符。

[optional body][optional footer(s)] 分别表示提交的详细信息和一些可选的注释信息。

示例

一个示例的 Git 提交信息可能是这样的:

feat: 新增用户注册功能
fix: 修复了登录页面的 BUG

或者

feat(login):  新增用户注册功

该功能包括了:
- 注册表单验证
- 用户数据存储
- 邮件通知功能

Closes #123
style: 更改了代码风格

该提交中的更改:
- 将所有变量名统一更改为驼峰命名法
- 将所有代码块缩进 2 个空格
- 删除了所有未使用的变量

在这个示例中,feat 表示本次提交是添加新功能,login 表示本次提交的范围是登录页面。

同时,还可以在提交信息中添加一些可选的注释信息,比如 Closes #123,表示本次提交与 issue #123 相关联,可以方便其他人快速了解本次提交的背景和目的。

总结

总之,Git 提交规范可以帮助团队成员更好地了解代码的变化、方便代码审核和维护,因此在团队协作中,应该尽可能地遵守统一的 Git 提交规范。