【知识整理】Git Commit Message 规范_vscode git commit message-CSDN博客

本文链接：https://blog.csdn.net/tjls2008/article/details/136262297

一. 概述

前面咱们整理过 Code Review 一文，提到了 Review 的重要性，已经同过gitlab进行CodeReview 的方式，那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。

我们在每次提交代码时，都需要编写 Commit Message，否则是不允许提交的。书写好的 Commit Message 能大大提高代码维护的效率。避免开发人员在项目中群魔乱舞，搞得代码一团糟，搞的项目就被糟践了。且开发日后的维护，都将是灾难。

因此，编写Commit Message需要遵循一定的范式，内容应该清晰明了，指明本次提交的目的，便于追踪问题。往往在日常开发中由于缺少对Commit Message的约束，导致填写内容随意，可读性低亦难以维护。今天“知识整理”就带大家一起来学习下Commit Message约束，希望对大家的工作有所帮助，大家觉得好的话，不要忘记给点个赞！受人玫瑰，手有余香。

二. 约束Commit规范的目的

统一团队 Git commit Message约束标准，便于后续代码Code Review，版本发布等。

统一团队 Git 工作流，包括分支使用规则、TAG 规范、ISSUE 等。

提供更多的信息，指明本次提交的目的，便于追踪问题，方便排查与决策。

通过过滤关键字，可以进行问题快速定位。提高工作效率

通过工具方便快速生成必要的文档。

三. 规范详细说明

Commit Message 的格式

大致分为三个部分 (使用空行分割):

标题行：必填，描述主要修改类型和内容
主题内容：描述为什么修改，做了什么样的修改，以及开发的思路等等
页脚注释：说明 Breaking Changes（中断更改）或 Closed Issues（已解决的问题）

每次提交，Commit Message 都包括三个部分：Header，Body 和 Footer。

# EN
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
# CH
<类型>[可选的作用域]: <描述>
// 空一行
[可选的正文]
// 空一行
[可选的脚注]

Commit Message 提示说明

# 标题行 类型（影响范围）：50个字符以内，描述主要变更内容
# 空