Skip to content

提交规范

  • git commit 提交信息格式
xml
<type>(<scope>): <subject>

说明

  • type:用于说明commit的提交类型,必选
  • scope:用于说明commit的影响范围,可选
  • subject:用于说明commit的细节描述,可选

type必选

类型功能描述
feat新功能添加新功能
fix修复问题修复bug
docs文档修改修改文档
style代码格式修改代码格式修改,不影响代码逻辑
refactor重构代码代码重构,不涉及新功能和修复问题
test测试用例新增添加测试用例
chore其他修改构建过程或辅助工具的变动
perf性能优化优化代码性能
revert回滚回滚到上一个版本,撤销某次代码提交
ci脚本更新脚本,修改CI或执行脚本配置
build构建修改构建流程,依赖库等
merge合并分支合并分支,合并分支代码到其他分支
sync同步同步分支代码到其他分支

工具

  • 前端规范提交工具一般是commitlint + lint-staged + husky, husky可以换成simple-git + simple-git-hooks
  • 配置工具后可以用优化提交步骤,不用手动输入完整格式的提交信息

Released under the MIT License.