Git代码提交规范详解:feat、fix、chore等常见类型的意义
创作时间:
作者:
@小白创作中心
Git代码提交规范详解:feat、fix、chore等常见类型的意义
引用
CSDN
1.
https://blog.csdn.net/chenyajundd/article/details/139322838
在软件开发过程中,Git是常用的版本控制系统,而规范的代码提交信息对于项目的维护和协作至关重要。本文将详细介绍Git中常见的提交类型及其含义,帮助开发者更好地理解和使用代码提交规范。
经常看到别人提交的代码记录里面包含一些feat、fix、chore等等,而我在提交时也不会区分什么,直接写下提交信息,今天就来看一下怎么个事,就拿 element-plus 举例来看一下
其实这么写是一种代码提交规范,当然不是为了炫技,主要目的是为了提高提交记录的可读性和自动化处理能力。
当然如果团队没有要求,不这么写也可以。
Git 提交规范
commit message = subject + :+ 空格 + message 主体
例如:feat::
增加用户注册功能
常见的 subject 种类以及含义如下:
- feat: 新功能(feature)
- 用于提交新功能。
- 例如:
feat: 增加用户注册功能
- fix: 修复 bug
- 用于提交 bug 修复。
- 例如:
fix: 修复登录页面崩溃的问题
- docs: 文档变更
- 用于提交仅文档相关的修改。
- 例如:
docs: 更新README文件
- style: 代码风格变动(不影响代码逻辑)
- 用于提交仅格式化、标点符号、空白等不影响代码运行的变更。
- 例如:
style: 删除多余的空行
- refactor: 代码重构(既不是新增功能也不是修复bug的代码更改)
- 用于提交代码重构。
- 例如:
refactor: 重构用户验证逻辑
- perf: 性能优化
- 用于提交提升性能的代码修改。
- 例如:
perf: 优化图片加载速度
- test: 添加或修改测试
- 用于提交测试相关的内容。
- 例如:
test: 增加用户模块的单元测试
- chore: 杂项(构建过程或辅助工具的变动)
- 用于提交构建过程、辅助工具等相关的内容修改。
- 例如:
chore: 更新依赖库
- build: 构建系统或外部依赖项的变更
- 用于提交影响构建系统的更改。
- 例如:
build: 升级webpack到版本5
- ci: 持续集成配置的变更
- 用于提交CI配置文件和脚本的修改。
- 例如:
ci: 修改GitHub Actions配置文件
- revert: 回滚
- 用于提交回滚之前的提交。
- 例如:
revert: 回滚feat: 增加用户注册功能
总结
使用规范的提交消息可以让项目更加模块化、易于维护和理解,同时也便于自动化工具(如发布工具或 Changelog 生成器)解析和处理提交记录。
通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。
热门推荐
如何解决鼻炎导致的黄绿色鼻涕问题
工程造价专业就业方向及前景!附2024大学排名及分数线
机械键盘在游戏中的不可忽视的优势与广泛应用
甲亢的治疗方法有哪些?分别是怎么治疗甲亢的?效果如何?
港理工为嫦娥六号研制仪器,完成人类史上首个月背表面采样任务
IP打造的迷雾与真相:数字人与IP的深度融合
Nvme硬盘、如何使用 nvme-cli 升级硬盘固件:详细教程
雨天行车安全技巧
大拇指和食指麻木进行肌电图检查需要穿刺吗
公积金利息结算时间及计算方式详解
如何在Windows 11 23H2版本中激活卓越性能模式?
光纤互连器件和无源器件检测
重庆话里的“得吃”是什么意思?
仑卡奈单抗药在全国投入使用,近百位患者提前获益“瑞金经验”
C++类型转换详解:从C风格到C++风格
面对人工智能发展的伦理挑战:应对策略与未来方向
淬火之后的升华:大型锻件回火技术全景解析
灶台贴膜哪种材质好?四种主流材质优缺点全解析
聚丙烯(PP)的三种类型:均聚、无规共聚与嵌段共聚的对比分析
Cell | 陈晓亚院士团队联合创制辅酶Q10水稻新种质
专业验光师教你避开配眼镜的常见陷阱
自制布丁教程,丝滑细腻,入口即化
请了月嫂还需要家人照顾吗?(请月嫂的注意事项及建议)
墨子思想:古代智慧在当代的回响
网络工程师必知!网络地址转换NAT的三种类型
网友公认的猫咪战斗力排行榜,第一名实至名归,不接受反驳!你家主子什么段位?
板绘光影效果怎么画?带你玩转光影!
清朝皇帝顺序表及皇后排名表
一代天骄成吉思汗:改变世界的征服者,创下了多个无法超越的奇迹
嘴上长水泡,原因、预防与护理全攻略