你可能已经忽略的git commit规范

Answer 1

在日常的开发工作中，我们通常使用 git 来管理代码，当对代码进行改动后，通过 git commit 来提交代码。git 规定提交时必须书写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人审核，还可以有效输出 CHANGELOG，提升项目的研发质量。然而，大部分开发者在日常工作中对于 log 信息的书写过于简单，这对于项目的管理和维护来说是不友好的。本文旨在结合个人经验分享 git commit 的一些规范，使你的 log 既“好看”又“实用”。

为什么要规范 git commit？让我们先看看一个不太规范的 commit 记录，看完有什么感觉？这种 commit 信息对于想要从中获取有效信息的人来说无疑是一种致命的打击。相反，社区内流行的 Angular 规范的 commit 记录则一目了然，提供了更多历史信息，方便快速浏览，同时可以过滤某些 commit（如文档改动），便于快速查找信息。

Angular 团队的 commit 规范具体是什么？它的 message 格式分为 Header、Body 和 Footer 三个部分。Header 部分包括 type（必需）、scope（可选）和 subject（必需）三个字段，Body 对本次 commit 修改内容进行具体描述，Footer 用于添加备注，如 BREAKING CHANGE（当前代码与上一个版本不兼容）或修复的 bug（关闭 Issue）的链接。

了解完规范，我们接下来讨论 git 提交信息模板。如果你的团队对提交信息有格式要求，可以在系统上创建一个文件作为模板，并配置 git 以遵循此模板。通过以下命令配置提交信息模板：新建.gitmessage.txt，内容如下。配置下来虽然可能觉得有些麻烦，但建立适合自己和团队使用的 git commit 规范并非易事。社区提供了辅助工具来帮助进行提交，下面将简单介绍这些工具。

commitizen（cz-cli）是一款交互式建立提交信息的工具，帮助从 type 开始逐步构建提交信息。commitlint 是一个提交验证工具，在实际的 git commit 提交到远程仓库之前使用 git 钩子验证信息，不满足规则的信息将被阻止提交。通过安装和配置，可以使用 commitlint 验证 commit message，确保其符合标准。commitizen 与 commitlint 可以根据不同的 adapter 配置 commit message，例如使用 Angular 的 commit message 格式，可以安装 cz-conventional-changelog。为了在每次 commit 时执行 commitlint 检查输入的 message，需要使用 husky 工具。

gitmoji 是一个实现 git 提交 commit 使用表情包功能的插件，使每次的 commit 更加直观，维护起来更方便。gitmoji 的使用非常简单，通过官方示例可以轻松上手。在项目中应用这些工具和规范，将使你的 git commit 更加规范，同时别忘了在 log 中加上 emoji，使沟通更加有趣。

最后，希望你能在项目中运用这些技巧，提高代码管理的效率和质量。同时，关注公众号【前端森林】，获取更多大前端相关的前沿文章和实战总结。以下是之前项目针对 git commit 配置的 package.json 示例，供参考。