Git Commit Message 代码约定式提交规范

上个月公司来了位前端大佬,给我们团队制订了一些技术方面的规范,其中有一项是关于在 Git 上提交代码写 Commit Message 的一些规范。开始我还觉得多此一举,看了许多大型项目的 Commit 记录之后,才知道这个规范算是行业里的标准。

先来看看我的 CodeStudy 项目里是写的什么 Commit Message:

再看看尤雨溪大佬的作品 Vue 框架的 Commit Message:

果然一个规范的 Commit Message 真的能让人眼前一亮,可以快速了解到该 Commit 的内容和涉及的功能模块。下面说说规范化 Commit Message 能带来什么好处。

规范化的好处

  • 便于程序员对提交历史进行追溯,了解发生了什么情况。
  • 一旦约束了 Commit Message,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个 git commit 里面,这样一来整个代码改动的历史也将更加清晰。
  • 格式化的 Commit Message 才可以用于自动化输出 Change log。

Git 提交规范

Plain Text Plain Text

<type>(<scope>): <subject><body><footer>

插件推荐

在 VS Code 上面强烈推荐 Commit Message Editor 插件,可以快速生成 Git Commit Message。