攻略网站的建设,wordpress自适应主题制作,绍兴网站开发08keji,汕头网站建设网站什么是约定式提交
约定式提交#xff08;Conventional Commits#xff09;是一种用于代码版本控制的规范#xff0c;旨在通过明确和标准化提交信息来提高代码协作质量和效率。其基本原则是通过规定提交信息的结构和语义来提高代码版本控制的可读性、可维护性和自动化程度。…什么是约定式提交
约定式提交Conventional Commits是一种用于代码版本控制的规范旨在通过明确和标准化提交信息来提高代码协作质量和效率。其基本原则是通过规定提交信息的结构和语义来提高代码版本控制的可读性、可维护性和自动化程度。
约定式提交规范通常要求提交信息包括一个描述性的类型、一个可选的作用域、一个用于简洁说明的主题以及可选的正文和尾部等组成部分。这些组成部分的格式和语义都是根据规范要求进行约定的比如使用feat来表示新功能、fix表示修复错误、docs表示文档变更等。
通过遵循约定式提交规范开发人员可以更容易地理解和管理代码的变更历史同时也为自动化工具提供了更多可靠的信息例如自动生成版本号、发布日志和代码库更新等操作。
提交说明的结构如下所示: 原文
type[optional scope]: description[optional body][optional footer(s)]
复制代码译文
类型[可选 范围]: 描述[可选 正文][可选 脚注]
复制代码提交说明包含了下面的结构化元素以向类库使用者表明其意图 fix: 类型 为 fix 的提交表示在代码库中修复了一个 bug这和语义化版本中的 PATCH[1] 相对应。 feat: 类型 为 feat 的提交表示在代码库中新增了一个功能这和语义化版本中的 MINOR[2] 相对应。 BREAKING CHANGE: 在脚注中包含 BREAKING CHANGE: 或 类型(范围) 后面有一个 ! 的提交表示引入了破坏性 API 变更这和语义化版本中的 MAJOR[3] 相对应。破坏性变更可以是任意 类型 提交的一部分。 除 fix: 和 feat: 之外也可以使用其它提交 类型 例如 \commitlint/config-conventional[4]基于 Angular 约定[5]中推荐的 build:、chore:、 ci:、docs:、style:、refactor:、perf:、test:等等。 脚注中除了 BREAKING CHANGE: description 其它条目应该采用类似 git trailer format[6] 这样的惯例。
其它提交类型在约定式提交规范中并没有强制限制并且在语义化版本中没有隐式影响除非它们包含 BREAKING CHANGE。可以为提交类型添加一个围在圆括号内的范围以为其提供额外的上下文信息。例如 feat(parser): adds ability to parse arrays.。
示例
包含了描述并且脚注中有破坏性变更的提交说明
feat: allow provided config object to extend other configsBREAKING CHANGE: extends key in config file is now used for extending other config files
复制代码包含了 ! 字符以提醒注意破坏性变更的提交说明
feat!: send an email to the customer when a product is shipped
复制代码包含了范围和破坏性变更 ! 的提交说明
feat(api)!: send an email to the customer when a product is shipped
复制代码包含了 ! 和 BREAKING CHANGE 脚注的提交说明
chore!: drop support for Node 6BREAKING CHANGE: use JavaScript features not available in Node 6.
复制代码不包含正文的提交说明
docs: correct spelling of CHANGELOG
复制代码包含范围的提交说明
feat(lang): add polish language
复制代码包含多行正文和多行脚注的提交说明
fix: prevent racing of requestsIntroduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.Remove timeouts which were used to mitigate the racing issue but are
obsolete now.Reviewed-by: Z
Refs: #123
复制代码type 类型概览
值描述feat新增一个功能fix修复一个Bugdocs文档变更style代码格式不影响功能例如空格、分号等格式修正refactor代码重构perf改善性能test测试build变更项目构建或外部依赖例如scopes: webpack、gulp、npm等ci更改持续集成软件的配置文件和package中的scripts命令例如scopes: Travis, Circle等chore变更构建流程或辅助工具revert代码回退 为什么需要约定式提交
Git提交信息需要遵循Angular约定是为了使提交信息格式清晰、易于阅读和理解从而提高代码协作的效率。Angular约定包括以下三个部分 标题header用一行简短的描述来总结更改内容并使用特殊关键字指定更改类型和影响范围。 正文body提供更详细的更改描述包括更改原因、影响和解决方案等信息。 页脚footer提供一些附加信息如相关链接、关联的BUG编号等。
通过遵循Angular约定可以使提交信息更加规范化和易于管理从而方便其他团队成员阅读和理解更改的含义从而提高团队协作效率。此外遵循Angular约定的提交信息还可以更好地与许多自动化工具进行集成如自动化版本控制、代码审查工具等。
如何遵守约定式提交
第一步自动生成提交说明的工具 Commitizen是一个基于命令行的交互式工具它可以帮助开发者规范化提交Git提交信息符合Angular Commit Message Conventions的规范从而更好地管理代码变更历史。 Commitizen提供了一个友好的命令行交互界面让开发者根据规范选择提交信息的类型、影响范围等内容自动生成符合规范的Git提交信息。
Commitizen可以与Git结合使用使得开发者可以使用commitizen命令代替git commit命令提交代码变更并且生成的提交信息格式更加规范化和易于管理。
这里我建议您全局安装
pnpm install -g commitizen
pnpm install -g cz-conventional-changelog
复制代码随后在电脑用户根目录穿件.czrc文件不然使用的时候会进入命令行笔者的系统为Ubuntu20.04
echo { path: cz-conventional-changelog } ~/.czrc
复制代码随后使用commitizen生成符合AngularJS规范的提交说明
commitizen init cz-conventional-changelog --save --save-exact
复制代码随后你就可以使用以下命令获得中规中距的commit信息了。
git cz
复制代码第二步客制化自动提交信息 cz-customizable是Commitizen的一个插件可以帮助开发者自定义符合Angular Commit Message Conventions的提交信息格式和内容。 拜托人又不是机器别那么死板。和代码打交道最重要的事情就是懂得如何苦中作乐在遇到挑战和困难时优秀的人能够采取积极的心态并且能够寻找解决问题的方式和方法。
cz-customizable提供了一些配置选项让开发者可以根据项目的需要自定义提交信息的格式和内容。
cz-customizable的配置选项包括 types: 定义提交信息的类型如feat新功能、fix修复Bug等。 scopes: 定义提交信息的影响范围如模块、组件等。 allowCustomScopes: 是否允许自定义影响范围。 scopeOverrides: 定义不同类型的提交信息对影响范围的要求。 messages: 定义提交信息的模板包括标题、正文、页脚等内容。 allowBreakingChanges: 是否允许提交破坏性变更。
1. 安装 cz-customizable
npm install cz-customizable --save-dev
复制代码2. 添加以下配置到package.json中
config: {commitizen: {path: node_modules/cz-customizable}
}
复制代码3.项目根目录下创建.cz-config.js文件来自定义提示
├── CHANGELOG.md
├── commitlint.config.js
├── index.html
├── node_modules
├── package.json
├── pnpm-lock.yaml
├── public
├── README.md
├── src
├── tsconfig.json
├── tsconfig.node.json
├── vite.config.ts
└── .cz-config.js // 创建
复制代码以下是我的一些参考配置
module.exports {// 可选类型types: [{value: :sparkles: feat,name: ✨ feat: 新功能},{value: :bug: fix,name: fix: 修复},{value: :memo: docs,name: docs: 文档变更},{value: :lipstick: style,name: style: 代码格式(不影响代码运行的变动)},{value: :recycle: refactor,name: ♻️ refactor: 重构 (既不增加feature, 也不是修复bug)},{value: :zap: perf,name: ⚡️ perf: 性能优化},{value: :white_check_mark: test,name: ✅ test: 增加测试},{value: :wrench: chore,name: chore: 构建过程或辅助工具的变动},{value: :rewind: revert,name: ⏪ revert: 回退},{value: :rocket: build,name: build: 打包}],// 步骤messages: {type: 请选择提交的类型,customScope: 情输入修改的范围(可选),subject: 请简要描述提交(必填),body: 请输入详细描述(可选),footer: 请输入要关闭的issus(可选),confirmCommit: 确认要使用以上信息提交(y/n)},// 默认长度72subjectLimit: 72
};复制代码此时再次运行 git cz时就可以看到
? 请选择提交的类型 (Use arrow keys)
❯ ✨ feat: 新功能 fix: 修复 docs: 文档变更 style: 代码格式(不影响代码运行的变动) ♻️ refactor: 重构 (既不增加feature, 也不是修复bug) ⚡️ perf: 性能优化 ✅ test: 增加测试
复制代码第三部增加对自动生成 commit 信息的校验 有时候你的队友可能是傻逼请你注意防范 很遗憾的是上面的操作并没有任何校验功能你的队友仍然可以提交 trash 在 commit 信息中。如果不敲你是队伍中的审核人员那么我想你需要设置一些规范
这里我们分情况讨论
若您没有使用cz-customizable适配器做了破坏Angular风格的提交说明配置则可以使用以下配置方案
1.安装 commitlint/config-conventional
npm i commitlint/config-conventional commitlint/cli -D
复制代码2.在根目录创建commitlint.config.js文件配置commitlint
module.exports {extends: [commitlint/config-conventional]
}
复制代码若您使用cz-customizable了则需要使用以下配置方案
npm install commitlint-config-cz --save-dev
复制代码
复制代码然后加入commitlint校验规则配置
module.exports {extends: [cz]
};
复制代码最后的一些补充
husky 最后的帮手 是一个可以在 Git hooks 中使用的 npm 包它可以帮助你在特定的 Git 事件发生时执行命令例如提交代码之前进行代码格式化、测试等操作. husky是一个为了方便使用Git hooks的工具它能够帮助你在项目中自动化地执行一些Git相关的操作。使用husky你可以在Git的一些关键操作例如提交、推送、合并等前或后执行一些脚本或命令比如代码格式化、自动化测试、打包发布等。
他可以帮助我们额外拦截一些如git commit等指令。需要注意的是husky只在Git仓库中才能正常工作所以在使用之前请确保你的项目已经初始化为Git仓库
1.安装 husky 在项目中安装 husky可以使用 npm或者 yarn 进行安装pnpm install husky --save-dev
复制代码或者
yarn add husky --dev
复制代码2.在package.json中定义需要执行的Git hooks和对应的脚本
例如在提交代码前执行代码格式化和自动化测试
jsonCopy code{husky: {hooks: {pre-commit: npm run lint npm run test}}
}
复制代码这样每次在执行git commit命令时都会自动执行npm中定义的lint和test命令。
除了pre-commit钩子husky还支持其他一些Git hooks比如pre-push、post-merge、post-checkout等可以根据实际需求进行配置。
需要注意的是husky只在Git仓库中才能正常工作所以在使用之前请确保你的项目已经初始化为Git仓库。
当然 除了在pageage.json中设置之外还可以使用
npx husky add .husky/pre-commit来生成一个 hook 的文件
随后你也可以在相应的文件中书写要执行的脚本了
./.husky/
├── _
│ └── husky.sh
├── commit-msg
└── pre-commit // 再此写入
复制代码3.使用lint-staged, 对暂存区代码进行eslint校验和prettier格式化
现在我们已经约束了提交规范但是我们希望在提交前对当前的代码进行格式验证和修复此时需要使用到lint-staged 安装 npm i lint-staged \--save-dev 在package.json中新增配置 lint-staged: {/*.scss: stylelint --syntax scss, /.{js,jsx, tsx,ts }: npm run lint-staged:js, **/.{js,jsx,tsx,ts,less,scss,md,json}: [ prettier --write ] } 复制代码 复制代码 在package.json中新增 lint-staged 和 lint-staged.js 命令 scripts: {lint-staged: lint-staged, lint-staged:js: eslint --ext .js,.jsx,.ts,.tsx } 复制代码 复制代码 最后在 pre-commit中新增脚本 npm run lint-staged
复制代码 给大家推荐一款好玩的脑筋急转弯的小程序吧脑筋急转弯是一种有趣的智力游戏能够有效锻炼思维能力和创造力。通过巧妙的问题和幽默的答案它不仅能带来欢乐还能激发我们的想象力和逻辑思维。无论是与朋友聚会时的互动还是家庭聚餐中的娱乐脑筋急转弯都是一种轻松愉快的选择。它适合各个年龄段的人帮助我们在欢笑中提升智力增进交流。快来挑战自己享受脑筋急转弯带来的乐趣吧V搜小程序DP去水印助手 最后送大家一句话(来自DP小程序助手语录)光就是羁绊之力它会再度被某人继承散发出耀眼的光。
