用代码审查规范和Commitizen提高团队协作效率

前端

2023-09-30 22:59:35

近年来，项目团队人手不足的情况愈发严重，常常需要招聘实习生给项目做需求，与此同时，项目的主维护人员对提交代码的代码审查做得不足，导致许多代码都是能跑就行地合到了master分支，逐渐积累下越来越多的技术债。

再者，代码风格缺乏硬性的制约。在开发的流程中，只有在代码合并到master分支的时候，才会进行一次代码审查，这导致代码审查的效率低下，也使得代码质量难以得到保证。

那么，如何解决这些问题呢？

1. 引入代码审查规范

代码审查规范是一套用于指导开发人员审查代码的规则和标准，通过遵守代码审查规范，开发人员可以确保代码的质量和一致性。

提交消息规范：提交消息是代码审查中非常重要的一部分，它可以让其他开发人员了解代码的变更内容和目的。
代码风格规范：代码风格是指代码的编写格式和规范，包括缩进、空格、命名约定等。
代码质量规范：代码质量是指代码的可读性、可维护性和可扩展性等方面。

2. 使用 Commitizen 和 Husky 工具

Commitizen 是一个命令行工具，它可以帮助开发人员生成符合代码审查规范的提交消息。Husky 是一个 Git 钩子工具，它可以在代码提交时自动执行一些任务，例如运行代码审查脚本。

具体的操作步骤：

安装 Commitizen 和 Husky 工具。
在项目中创建一个 .husky 文件夹。
在 .husky 文件夹中创建一个 pre-commit 文件。
在 pre-commit 文件中添加以下代码：

#!/bin/sh

# 检查代码风格
npm run lint

# 生成提交消息
npx commitizen init cz-conventional-changelog --save-dev

git cz

在项目中创建一个 .czrc 文件。
在 .czrc 文件中添加以下代码：

{
  "path": "conventional-changelog/conventional-changelog",
  "questions": [
    {
      "type": "input",
      "name": "title",
      "message": "Summary of changes (max 72 chars)"
    },
    {
      "type": "input",
      "name": "body",
      "message": "Provide a longer description of the changes (optional)"
    },
    {
      "type": "confirm",
      "name": "isBreaking",
      "message": "Are there any breaking changes?",
      "default": false
    },
    {
      "type": "input",
      "name": "breakingBody",
      "message": "A BREAKING CHANGE commit requires a body. Please enter a longer description of the breaking change(s).",
      "when": "isBreaking"
    },
    {
      "type": "input",
      "name": "footer",
      "message": "List any fixes or closing issues in this commit (optional)"
    }
  ]
}