Git Commit 规范流程化
2020/6/21 11:26:36
本文主要是介绍Git Commit 规范流程化,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
结合
commitizen
commitlint
conventional-changelog-cli
husky
,进行封装,一键安装,开箱即用的git commit
规范。
团队多人协作开发时,每个开发人员习惯不同,提交 commit 信息不一,而项目中 commit 信息极为重要,是梳理不同阶段项目迭代维护情况的直观表现,也是复盘时 code view 的最好选择途径。团队梳理出相关 commit 规范后,配套相应的约束工具,从而让每个开发者提交 commit 信息时都能遵守一套相应的准则, 让项目中的 commit message 看起来更优雅和清晰。
涉及相关插件
主要 commit 约束插件:
-
commitizen 一个格式化 commit message 的工具
-
commitlint 检查 commit message 是否符合常规的提交格式。
-
conventional-changelog-cli 每次 commit 后产生 change log 日志文件
-
@commitlint/config-conventional 一些常规的 commitlint 规则,如果不满足,将产生一个非零的退出代码,退出当前执行程序。
辅助插件:
- vue-cli-plugin-commitlint vue 官方提供的代码提交规范, 主要是提示信息是中文
- husky git hooks
安装:
npm i vue-cli-plugin-commitlint commitizen commitlint conventional-changelog-cli husky -D 复制代码
功能:
- 自动检测 commit 是否规范,不规范不允许提交
- 自动提示 commit 填写格式。不怕忘记规范怎么写
- 集成 git add . && git commit 不需要在执行两个命令
- 自动生成 changelog
配置
-
pacakge.json
{ "scripts": { "log": "conventional-changelog --config ./node_modules/vue-cli-plugin-commitlint/lib/log -i CHANGELOG.md -s -r 0", "cz": "npm run log && git add . && git cz", }, "config": { "commitizen": { "path": "./node_modules/vue-cli-plugin-commitlint/lib/cz" } }, "husky": { "hooks": { "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" } } } 复制代码
-
新增 commitment.config.js 文件
module.exports = { extends: [ './node_modules/vue-cli-plugin-commitlint/lib/lint', '@commitlint/config-conventional' ] }; 复制代码
-
使用
# 生成 changelog 文件 并执行 git add . && git commit -m "" npm run cz # 生成 changelog 文件 npm run log 复制代码
这篇关于Git Commit 规范流程化的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-09-19Excel数据导出课程:初学者必备教程
- 2024-09-19Excel数据导入课程:新手入门指南
- 2024-09-19RBAC的权限管理入门教程
- 2024-09-19如何使用Svg Sprite Icon制作图标
- 2024-09-19uniapp 如何实现点赞后全局更新数据-icode9专业技术文章分享
- 2024-09-19云函数怎么运行wx-server-sdk-icode9专业技术文章分享
- 2024-09-19"dependencies": { "wx-server-sdk": "latest" },是什么意思-icode9专业技术文章分享
- 2024-09-16优化批处理流程:自定义BatchProcessorUtils的设计与应用
- 2024-09-15laravel collect游标批量插入的方法示例-icode9专业技术文章分享
- 2024-09-15怎么修改laravel的中间件 把获取IP改成X-Real-IP-icode9专业技术文章分享