6、通过husky规范commit提交信息
团队项目中可以从你的commit记录看到你的动作信息规范提交必须按照如下格式避免有人出现这样的提交 git commit -m “update”feat新功能featuerfix:修补bug docs 文档documentation perf性能优化 style格式修改样式不影响代码运行的变动 refactor重构既不是新增功能也不是修改bug的代码变动 chore构建过程或辅助工具的变动 revert撤销版本回退 test测试 improvement改进 build打包 ci持续集成可以自己写命令完成对commit信息的校验当然也可以借助第三方工具库以下是工具库的方法第一步npm install-Dcommitlint commitlint/config-conventional commitlint/cli第二步项目根目录新建这个文件文件内容如下.commitlintrc{extends:[commitlint/config-conventional]}这个工具库对应的规则是怎样的既然你使用了 commitlint/config-conventional那么你的提交记录必须遵循 Conventional Commits约定式提交 规范。这种格式目前是社区如 Angular、Vue、React最通用的标准。一个规范的提交信息结构如下type(scope): description核心字段详解Type必需 用于说明本次提交的类型。常用类型包括 feat: 引入新功能feature。 fix: 修复 Bug。 docs: 仅修改文档如 README。 style: 格式化修改不影响代码运行如空格、分号等。 refactor: 代码重构既不是修复 Bug 也不是加新功能。 perf: 提高性能的代码更改。 test: 添加或修改测试用例。 chore: 构建过程、辅助工具或依赖库的变动如更新 npm 包。 revert: 撤销之前的提交。 Scope可选 说明影响的范围。例如feat(auth):、fix(header):。 Description必需 对变动的简短描述。 规则首字母通常小写结尾不加句号.。 4. 正确示例 ✅ feat: add login functionality基础 fix(api): handle unauthorized error带作用域 docs: update installation steps文档 chore: update husky to v9依赖更新 5. 错误示例 ❌会导致 commit 失败 Fixed the bug缺少 type 类型 feat:Add login冒号后缺少空格 update code格式完全不对 进阶建议使用 commitizen如果你觉得手动输入这些格式太麻烦可以安装 commitizen。它会通过问答的方式帮你生成符合规范的提交信息安装npm install -D commitizen cz-conventional-changelog在 package.json 中配置“scripts”: {“commit”: “cz”}第三步将提交的信息验证也通过husky进行管理了代码意思在提交信息的时候执行 提交信息验证 javascript npx husky add .husky/commit-msg npx --no -- commitlint --edit ${1}验证一把是否生效
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2549029.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!