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 生成器)解析和处理提交记录。
通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。
热门推荐
工业机器人六大岗位详解:从操作到编程,从维修到系统集成
紫微斗数入门:十二宫位与四化星详解
中国制造的“新质”吸引力
公司印章管理全攻略:种类、用途与法律风险防范
为何梅长苏的复仇能成,誉王的复国却是一败涂地?
一种远被低估的运动方式,1 周哪怕做 1 次,对身体的好处都远超想象
线性回归模型&成本函数
线性回归模型详解:原理、应用与局限性
什么是量化投资?如何通过数据分析提升投资效率?
10种公认阳台最好养的花
共享单车车锁结构图详解:从传统机械锁到智能电子锁
深圳社区公园建设:从废弃地到居民休闲场所的转变
如何在计算机编程中正确使用分隔符
长安CS75倒车镜更换价格参考
电动车怎样充电才能使电动车寿命长
藏在地图里的中国——中国的气候类型②
上证指数详解:构成、计算方法及其市场参考价值
上证指数详解:构成、计算方法及其市场参考价值
PET/CT在癌症转移诊断中的应用
如何选择适合自己的护肤品?这些参考因素帮你做出明智选择
Excel提示下标越界怎么办
消防系统怎么配对设备管理
网工基础知识:多路复用技术详解
肠胃镜检查后应该吃什么食物
徐铉:五代至北宋的文学与书法巨匠
消防安全,从我做起!用火、用电、用气安全小贴士
阅读理解与文本分析
FDA审评:吡托布鲁替尼制剂溶出方法开发与标准制定
探索大型语言模型(LLM)在人类性格个性评估(MBTI)中的前景与应用
中德合作:科思创与广汽集团携手推动飞行汽车材料创新