Git Commit:Commitlint 提交信息规范

282 阅读1分钟

Git Commit:Commitlint 提交信息规范

引文
commitlint 可以对 git commit -m message 中的 message 信息进行约束,约束规则也可以在commitlint.config.js.commitlintrc.js.commitlintrc.commitlintrc.json 文件中配置, 常规用法如下

基本格式

type[(scope)]: subject 示例格式: feat: messagefeat(scope): message

字段描述

* type

  • fix - Bug 修复
  • feat - 新增功能
  • build - 构建工具或项目依赖的改动,如 webpack/rollup 配置
  • docs - 文档相关内容改动,如添加注释
  • style - 不会影响系统功能的代码格式相关改动,如删除/添加空格
  • refactor - 代码重构改动, 如 vue2 -> vue3
  • revert - 执行 git revert 之后的 revert 信息
  • test - 添加单元测试
  • perf - 性能相关改动

* subject

提交信息概述,必填,能够简短概述本次提交的主体内容即可

scope

代码修改范围,可选

示例

错误示例

  • fix: - 没有概述信息
  • other: message - type 不正确
  • Fix: message - type 需要是小写

正确示例

  • fix: message
  • fix(scope): message

参考文档

commitlint
commitlint/config-conventional