配置 git 提交规范


 团队提交规范

<类型>[可选 范围]: <描述>
[可选 正文]
[可选 脚注]
feat[登录功能]: 新增登录功能模块

完成登录功能模块...

第66个功能
  • 新增功能  feat 
  • 修复  fix 
  • 文档变更  docs 

Commitizen提交规范化工具

  1. 安装Commitizen工具  npm i -g commitizen@4.2.2 
  2. 安装相关插件  npm i cz-customizable@6.3.0 --save-dev 
  3.  package.json 文件新增配置 
    "config": {
      "commitizen": {
        "path": "node_modules/cz-customizable"
      }
    }
  4. 项目的根目录下新增  .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/e/h)'
      },
      // 跳过问题
      skipQuestions: ['footer'],
      // subject文字长度默认是72
      subjectLimit: 72
    }
  5. 使用  git cz 代替  git commit 命令
Git