用工具思路来规范化 git commit message

用工具思路来规范化 Git Commit Message

在前端项目开发中，使用Git进行版本控制是必不可少的。而在使用Git时，Commit Message的书写质量对于开发团队的协作效率以及代码质量的保证有着重要的影响。

一个好的Commit Message应该清晰、简洁、易于理解，并且包含足够的上下文信息。为了达到这个目标，我们可以采用一些工具和约定来规范化Commit Message的书写。

工具思路

Commitizen

Commitizen是一个由AngularJS团队维护的Git提交信息规范化工具，它提供了一个交互式命令行工具，帮助我们生成符合规范的Commit Message。

使用Commitizen可以避免手动写Commit Message时存在的模糊、不准确、不规范等问题，从而提高了提交信息的质量。

安装

--- ------- -- ---------- -------------------------

使用方法

- ----------------- --------
--- --

- --------
--- --- ------

Commitizen会引导我们回答一系列的问题（如类型、作用域、修改内容、关联的Issue等），然后将这些答案组合成一个符合规范的Commit Message。

Husky + commitlint

Husky是一个可以帮助我们在Git钩子（Git Hooks）中执行脚本的工具。而commitlint则是一个可以对Commit Message进行校验的工具。

使用这两个工具，我们可以在每次提交时自动校验Commit Message是否符合规范，从而及时发现和修复不规范的提交信息。

安装

--- ------- ---------- ----- -------------------------------------

配置

在package.json中添加以下代码：

-
  -------- -
    -------- -
      ------------- ----------- -- -----------------
    -
  --
  ------------- -
    ---------- -----------------------------------
  -
-

这样，在每次提交时，Commit Message都会被commitlint校验。如果不符合规范，就会被拒绝提交。

规范化Commit Message的约定

除了使用工具之外，还有一些约定可以帮助我们规范化Commit Message的书写。下面是一些常见的约定：

类型（type）

Commit Message中必须包含一个类型，表示修改的类型。以下是一些常见的类型：

feat：新功能
fix：修复问题
docs：文档修改
style：代码格式修改
refactor：重构代码
test：测试相关
chore：构建、配置或工具相关

范围（scope）

Scope表示修改的范围，用于描述修改的具体位置。如果修改涉及到多个位置，则使用*表示所有位置。

主题（subject）

Subject是一个简短的描述，用于概括修改的内容。它应该清晰、简洁、易于理解。

正文（body）

Commit Message的正文描述了修改的详细内容。它应该具有足够的上下文信息，以便其他开发人员可以理解修改的目的和影响。

脚注（footer）

Footer中可以包含一些额外的信息，例如修复的Issue编号、关联的Pull Request等。

示例代码

一个符合规范的Commit Message应该包含类型、作用域、主题和正文，尽可能地提供清晰明了的上下文信息。

以下是一个示例Commit Message：

----------- --- ----- ----

--- - --- ----- ---- -- ----- -----

----------------------------------------------------------- ----------
---------------------------------------------------------------------------------------