Git 提交规范

2023-03-14 17:12:06 浏览数 (2)

在团队协作中,Git 提交规范对于代码的可维护性和版本管理非常重要。下面总结了一些常见的提交规范:

提交信息格式

每个 Git 提交信息都应该包含一个清晰简洁的标题和一个更详细的描述。推荐的提交信息格式如下:

代码语言:txt复制
<type>(<scope>): <subject>

<BLANK LINE>

<body>

<BLANK LINE>

<footer>

其中,<type> 代表提交类型,<scope> 代表影响范围,<subject> 是提交信息的简短描述,<body> 是详细描述,<footer> 是一些元数据,比如关联的 issue、PR 等。

提交类型

常见的提交类型包括:

  • feat:新功能
  • fix:修复 bug
  • docs:文档修改
  • style:代码格式修改,比如缩进、空格等
  • refactor:代码重构
  • test:测试相关修改
  • chore:其他修改,比如构建流程、辅助工具等

影响范围

<scope> 表示影响的范围,可以是文件名、模块名、功能名等,也可以省略不写。

提交信息示例

下面是一个示例提交信息的格式:

代码语言:txt复制
feat(proto-gen): 协议导出c  

支持协议自动生成c  代码

Closes #123

在这个示例中,feat(proto-gen) 表示添加了新功能,协议导出c 是简要描述,支持了协议导出c 代码, 支持协议自动生成c 代码 是提交信息的详细描述,Closes #123 表示关联了 Issue #123。

总结

遵循 Git 提交规范可以让团队协作更加高效和规范,也更容易进行版本管理和代码维护。希望大家都能养成良好的提交习惯!

0 人点赞