Git commit 提交规范

183 阅读1分钟

日常开发中为了统一规范我们在git提交的时候commit -m “备注的信息”,我们需要进行git的规范。

一、安装commitizen

  1. cnpm i -g commitizen
  2. cnpm i cz-customizable --save-dev

二、package.json配置

  1. commitizen init cz-conventional-changelog --save --save-exact
  2. cnpm init --yes

三、使用git cz 代替git commit -m 提交

1654597033(1).png

四、自定义提交的规则

  1. cnpm i cz-customizable --save-dev

  2. 在根目录中添加一个文件 .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: ['body', 'footer'],
  // subject文字长度默认是72
  subjectLimit: 72
}

1654598021(1).png