返回

开箱即用的代码提交规范

前端

团队代码提交的不规范问题

在大型项目中，代码的修改迭代非常快，如果是几个人同时修改同一个模块，这样会有非常多乱七八糟的 commit。

经常会发现，提交一个 commit 后，发现有一段代码写错了，这个时候人们习惯性地去修改提交，而不再新建一个 commit。

每个人都会有自己的开发习惯，可能不会像我一样，在项目中使用 eslint，有的同学可能就经常会有代码不规范的问题，即使使用了 eslint 这样工具，也会有一些同学关闭这个功能。

什么是代码提交规范

我认为代码提交规范就是，每个人都按照自己的习惯在本地开发，然后 push 到远程仓库前，都强制格式化一下 commit 的提交信息。

为什么要有代码提交规范

有以下几点原因：

  • 格式化的 commit 信息，可以一目了然看出本次 commit 的修改信息。
  • 格式化的 commit 信息，能够知道是谁提交的，提交的时间是什么时候，方便回溯问题。
  • 格式化的 commit 信息，能帮助代码的维护人员快速定位问题。
  • 格式化的 commit 信息，可以防止胡乱提交导致的问题。

代码提交规范如何应用

这里介绍一个 VSCode 代码编辑器插件 vue-cli3 commit 规范插件，这个插件的使用很简单，只需要安装了就自动生效。

自动生效时，就会强制要求开发人员使用下列格式去写 commit 信息：

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

<body>

<footer>

格式的意义：

  • <type>：commit 的类型，比如：feat（新特性）、fix（修复缺陷）、docs（文档）、style（样式）、refactor（重构）、perf（性能优化）、test（测试相关）、build（构建系统）
  • <scope>：修改的范围，可以是模块名、文件名、组件名等
  • <subject>：修改的简要说明，一般使用动宾结构，使用现在时态，不能超过50个字符
  • <body>：修改的详细说明，可以多行，可以不写
  • <footer>：提交的备注，可以是 BREAKING CHANGE 或相关issue的链接，可以不写

需要注意的是，这是强制要求开发人员使用这种规范的。

如何关闭代码提交规范

有的同学可能不太习惯这种强制规范，想要关闭的话，可以在 VSCode 中的设置中进行修改：

Search 中搜索 "commit guidelines"，然后把 Enforce Commit Guidelines 选项关闭即可：

![](/Users/soulwu/Desktop/Screen Shot 2023-03-10 at 11.16.38 PM.png)

总结

本文介绍了代码提交规范的意义和使用。虽然强制使用规范可能不太符合个别开发者的习惯，但是个人认为代码规范化的好处是显而易见的。