Git提交规范

Commitizen助你规范提交代码

为什么需要这个呢?因为现在开发团队都是多人协作,每个人提交代码风格不一样,而且很难约定规范

Commitizen的仓库名为cz-cli,它提供了一个"git cz"的指令用于代替git commit,简单来说就是当你在git commit时候得填写所有必须的提交字段

下面上步骤:

1.全局安装Commitizen

npm install -g commitizen@4.2.4

2.安装并配置cz-customizable插件

   (1)使用npm下载cz-customizable

npm i cz-customizable@6.3.0 --save-dev

  (2)添加以下配置到package.json中

...
"config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  }

3.项目根目录下创建.cz-config.js自定义提示文件

module.exports = {
  types: [
    {
      value: "feat",
      name: "feat:新功能",
    },
    {
      value: "fix",
      name: "fix:修复",
    },
    {
      value: "docs",
      name: "docs:文档变更",
    },
    {
      value: "style",
      name: "style:代码格式(不影响代码运行的变动)",
    },
    {
      value: "refactor",
      name: "refactor:重构(既不是增加feature,也不是修复bug)",
    },
    {
      value: "perf",
      name: "perf:性能优化",
    },
    {
      value: "test",
      name: "test:增加测试",
    },
    {
      value: "chore",
      name: "chore:重构过程或辅助工具的变动",
    },
    {
      value: "revert",
      name: "revert:回退",
    },
    {
      value: "build",
      name: "build:打包",
    },
  ],
  //步骤
  messages: {
    type: "请选择提交的类型",
    customScope: "请输入修改的范围(可选)",
    subject: "请简要描述提交(必填)",
    body: "请输入详细描述(可选)",
    footer: "请输入要关闭的issue(可选)",
    confirmCommit: "确认要使用以上信息提交(y/n)",
  },
  // 跳过步骤
  skipQuestions: ["body", "footer"],
  // 默认长度为72
  subjectLimit: 72,
};

4.使用git cz 代替 git commit

使用git cz代替git commit,就可以看到提示内容.

如果不小心忘记使用git cz指令,直接提交代码怎么办呢?

点击查看