Git —— Commit Message 规范介绍_git commit message

作者：我家小花儿 | 2024-04-16 17:21:21

踩

git commit message

Git —— Commit Message 规范介绍

为什么要规范 Commit Message

日常开发中，我们经常会使用到 Git 进行代码管理，而 Git 中最常用的命令就是 git commit，我们通过 commit 命令将修改后的代码提交到本地仓库，然后再通过 git push 命令将本地仓库的代码推送到远程仓库。

git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升，尤其是一些长期持续迭代维护，且多版本长期并存的项目。

优秀的规范化 Commit Message 应该具备以下优点：

清晰明了：commit message 应该清晰明了，说明本次提交的目的，具体做了什么操作。这样可以让团队成员更好地理解每次提交的内容。
便于追溯：规范的 commit message 可以帮助程序员对提交历史进行追溯，了解发生了什么情况。
提高研发效率：一旦约束了 commit message，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个 git commit 里面，这样一来整个代码改动的历史也将更加清晰。
自动化工具的友好性：规范的 commit message 可以被自动化工具用于生成发布日志或自动化版本号管理。
降低代码维护成本：如果 commit message 写得不清楚，例如使用 “fix bug” 这样笼统的描述，可能会导致后续代码维护成本特别大，有时自己都不知道自己的 “fix bug” 修复的是什么问题

因此，规范化的 commit message 对于团队协作和项目管理是非常重要的。

Commit Message 规范

在 Git 中 Commit Message 的规范又很多种，其中比较受欢迎的有以下这些：

Angular 规范：这是目前使用最广的写法，比较合理和系统化，并且有配套工具可以辅助生成（VS CODE 插件：git-commit-plugin）。
Conventional Commits 规范：这是一个基于语义化版本 (semver) 和简单的消息格式的轻量级约定，一传达代码更改的意图。

这里我们着重介绍一下 Angular 规范。

Angular 规范

Angular 规范是一种广泛应用于软件开发中的提交信息（commit message）规范，其目的在于提供一种统一、清晰的提交信息格式，以便于开发者和维护者理解代码的变动情况。

Angular 规范将提交信息分为三个部分：Header、Body 和 Footer。

Header：Header 是提交信息的头部，包含三个字段：type、scope 和 subject。
- type：type 字段用于指明本次提交的类型，例如：feat（新功能）、fix（修补bug）、docs（文档）、style（格式）、refactor（重构）、perf（性能优化）、test（增加测试）、chore（构建过程或辅助工具的变动）等。
- scope：scope 字段用于指明本次提交影响的范围，例如：数据层、控制层、视图层等。这个字段是可选的。
- subject：subject 字段是对本次提交目的的简短描述，不超过50个字符。
Body：Body 是提交信息的主体部分，用于详细描述本次提交的内容和原因。这个部分是可选的。
Footer：Footer 是提交信息的尾部，通常用于记录不兼容变动和关闭 Issue。这个部分也是可选的。

Angular 规范的提交信息格式如下：

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
1
2
3
4
5

以上就是 Angular 规范的基本内容。遵循这种规范可以帮助我们更好地管理代码提交的内容，使得每次提交的目的和主要改动都能清晰地体现在 Commit Message 中，便于后续的代码维护和版本管理。具体的规范可能会因团队和项目的不同而有所差异。所以，虽然 Git 本身没有强制的 Commit Message 规范，但在实际使用中，我们通常会根据实际需求来约定一些规范，以提高代码的可读性和维护性。

Commit Message 规范工具

在实际开发中，我们通常会使用一些工具来帮助我们规范 Commit Message，这样可以避免我们手动编写 Commit Message，提高开发效率。

这里介绍一个 VS Code 插件：git-commit-plugin，它可以帮助我们快速生成符合 Angular 规范的 Commit Message。这是它的仓库地址：https://github.com/RedJue/git-commit-plugin。我们也可以直接在 VS Code 的扩展商店中直接下载安装。

注意：商店中有两个名为 git-commit-plugin 的插件，我们选择作者为 redjue 的那一个。另一个为fork的版本，已经不再维护。

git-commit-plugin

安装完成后，我们点击 VS Code 左侧面板的存储库图标，可以看到存储库的右边出现了一个 git 图标，点击它就可以打开 git-commit-plugin 的界面。

打开 git-commit-plugin 界面：
选择提交类型，这里以 fix 为例：
按照 Angular 规范依次完成 scope，subject，body 和 footer 字段
完成每项内容的填写后，点击 Complete，插件会将填写的内容，按照规范自动生成在左侧源代码管理面板中的提交信息中：

注意此处 VS Code 会提示“当前行比72超出39个字符”，这是因为 VS Code 限制了提交消息每行的最大长度。我们在上一步编辑 Body 时，受限于插件的界面，将所有内容都写在了一行中，因此在这里我们需要将 Body 部分的内容进行换行，达到美观和规范的目的。
最后我们点击提交按钮将本次修改提交到本地仓库，再点击同步就可以将本地仓库的提交记录推送到远程仓库了。

Commit Message 模板的配置和使用

在某些环境下，可能仅有的就是一个命令行终端，我们需要在命令行中手动输入 Commit Message。这时候我们就需要一个 Commit Message 模板来帮助我们快速生成符合规范的 Commit Message。

以 Linux 端为例，git 提供了一个 commit.template 的配置项，用来指定期望使用的 Commit Message 模板。

首先我们在项目的根目录创建一个 .gitmessage 文件，用来存放 Commit Message 模板：
```
touch .gitmessage
1
```

然后我们编辑 .gitmessage 文件，将以下内容复制到 .gitmessage 文件中：

# head: <type>(<scope>): <subject>
# - type: ✨ feat, 声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家小花儿/article/detail/435501

推荐阅读

相关标签