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 生成器)解析和处理提交记录。
通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。
热门推荐
开源和闭源对大模型有什么影响?
只需转发链接就能赚钱?起底“标题党”网文背后的网络黑产
钳形接地电阻测试仪使用方法及原理
楼盘封盘是什么意思
崔颢《黄鹤楼》:唐人七言律诗第一
北冰洋厚海冰致西北航道通航季缩短
下颌部位有个滑动的硬块怎么办?
心脑血管疾病风险大,智能医疗手表可随时监测
美林投资时钟:掌握市场周期的投资策略分析
系统架构图怎么画
电解质散不排便?原因与科学服用指南
多次合作的演员情侣:玄彬和孙艺珍
Win11微信文件拉不进文件夹?原因分析及解决方法详解
冯骥才:是作家,更是中华文化遗产的守护者
什么是折现率?影响折现率的因素有哪些?
抓获29人涉案金额超三千万!邵阳武冈警方侦破近年来最大地下“六合彩”赌博案
如何巧妙运用调侃:社交场合的润滑剂
紫苏的功效与食疗价值:从《本草纲目》到现代养生实践
紫苏叶的多种用途:从药用到食用的全面指南
脉压差大是什么原因引起的
脉压差大有哪些原因?
滴滴人证车证在哪?法律合规与证件管理的深度解析
狗狗为何频繁食草?(探究狗狗吃草的原因及其健康影响)
准备开庭了需要准备什么材料
平角的定义和性质的区别
肺炎位居十大死因第三名!精选5种日常养肺茶,提前预防肺部感染最有效
剩菜的亚硝酸盐是怎么产生的
社区也能住院?西安已布局11家卫星医院
《数字货运平台司机就业与收入研究报告》在京发布
18650锂电池充电器选购指南:如何选择合适的充电设备