代码提交规范---commitlint

.commitlintrc.js文件

commitlint:  CommitLint 是一个用于规范化 Git 提交消息格式的工具,它通过对提交消息的格式进行校验,帮助团队保持统一的提交消息规范,有助于提高代码库的可读性和维护性。

/**
 * build 编译相关的修改,例如发布版本、对项目构建或者依赖的改动
 * chore 其他修改, 比如改变构建流程、或者增加依赖库、工具等
 * docs 文档修改
 * feat 新特性、新功能
 * fix 修改bug
 * perf 优化相关,比如提升性能、体验
 * refactor 代码重构
 * revert 回滚到上一个版本
 * style 代码格式修改
 * test 测试用例修改
 */

module.exports = {
  extends: [
    '@commitlint/config-conventional',
  ],
}

package.json文件

husky配置:Husky 是一个 Git hooks 工具,可以让开发者在 Git 提交、提交、push 等操作前执行预定义的脚本,从而帮助团队规范化提交流程和代码质量。Husky 可以与其他工具(如 lint-staged、linters、测试工具等)结合使用,以确保代码在提交到版本控制系统之前经过检查和验证。

……
  },
  "devDependencies": {
    "@commitlint/cli": "^17.6.6",
    "@commitlint/config-conventional": "^17.6.6",
    ……
    "husky": "8.0.3",
    ……
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值