Git Commit 提交规范

发布时间：2023-05-20

为什么需要 Git Commit 提交规范

Git 是一个非常强大的版本管理工具，它可以让开发者更高效地协同工作。在开发过程中，Git Commit 提交是非常重要的环节，因为它记录了代码的改动和进度。 然而，过多的无意义或不规范的提交信息会使得代码变更追踪变得困难，给团队合作和代码维护造成很大的麻烦。因此，为了更好地管理和追踪代码，需要 Git Commit 提交规范。

如何制定 Git Commit 提交规范

一个好的 Git Commit 提交规范可以细化每次提交，提高代码可读性和可维护性，同时也方便管理和检查代码变化。

1. 统一的提交格式

按照统一的提交格式可以让团队成员更容易理解和比对每次提交所做的改动。一般的格式包括三个部分：

type(scope): subject 
body
footer

其中，type 和 subject 是必需的，body 和 footer 是可选的。下面详细说明每个部分：

  • type：表示本次提交的类型，常见的 type 有以下几种：
    • feat：新增 feature
    • fix：修复 bug
    • docs：文档更新
    • style：样式更新等
    • refactor：重构代码
    • test：添加或修改测试代码
    • chore：构建过程或辅助工具的变动
  • scope：表示改动的范围，可以是文件名、模块名等，可选
  • subject：简短描述本次提交的目的，注意使用动词和第一人称，例如“增加了新特性”而不是“增加了新特性模块”
  • body：添加详细的描述和说明，可选
  • footer：添加其他相关信息，如关闭 issue 的信息，可选

2. 统一的 Commit Message 模板

制定一个符合需求、简洁明了、易于使用的模板，可以保证团队成员按照统一的标准进行提交。例如：

[type](scope): subject 
body
footer

3. 个性化 Scope 的使用

在使用时，可以根据实际情况进行个性化定制，例如可以将 scope 指定为文件名、模块名、功能等，方便查看和搜索变更。

4. 提示性的 Commit Message

为了让团队成员更好地理解每个提交和提高代码可读性，可以在 Commit Message 中加入一些提示信息，例如使用 emoji 表情、语义化版本号等。

:tada:(scope): subject 
body
Version: 1.0.0

Git Commit 提交规范的好处

采用规范的 Git Commit 提交方式，可以在一定程度上提供代码的可读性和可维护性，在大型项目中流程化、标准化的操作更能发挥其价值。

1. 便于版本管理和跟踪

规范的 Git Commit 提交格式有助于快速查找、过滤、排序、比对代码版本，方便代码追溯与维护。

2. 提高团队协作效率

规范的提交方式使得团队成员的提交方式更加一致、准确而不是杂乱，利于项目管理者或其他团队成员了解本次提交，同时也使得代码更加易读和易理解，方便其他成员进行协作开发。

3. 优化开发流程

统一的规范可以提高工作效率，减少重复工作和错误提交，更容易定位代码问题，加快代码部署的速度。

代码示例

feat(erp): 增加新需求
在erp模块中增加了订单创建功能，可在主页进入
:sparkles: :bookmark:
fix(mobile): 修复产品不显示的问题
在部分移动端上，产品展示出了问题，进行了修复
#123
docs(readme): 更新文档
在 README 中补充了说明相关内容
:memo:
推荐文章