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 生成器)解析和处理提交记录。
通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。
热门推荐
黑山 科托尔湾 佩拉斯特
冷静下来,倾听自己:最常见的扑克心态
胡可:曾是主持人、演员很有灵气,为家庭牺牲事业又选择重新出发
世界史上最能征善战的五大帝国,中国独占其二
王者荣耀明世隐技能全解析 掌握明世隐技能
电竞显示器参数解析:240Hz+1ms是否必要?
Cell | 中国科学院分子植物卓越中心应邀撰写微生物组助力绿色农业的综述展望
P&ID和PFD的区别
急性颅脑损伤患者的急救与护理
【原】诱鱼入瓮 —— 钓鱼钓的多,离不开打窝
顶级人才为何离开华为?招来一群聪明人不容易,留住就更难了
五行相生相克实际运用 五行相生相克经典分析
三国历史中十大常被人忽略的将领
Nature再发招聘调查:学术界和工业界大不同,帮你避坑从简历到面试的N个细节
成为网约车司机的完整指南
拆解一台90年代的组合音响主机,每个老元件都有时代的印记
重启网络服务器,会带来哪些影响与后果?
《权力的游戏》大结局和原著《冰与火之歌》的不同之处
时评:环岛高铁乘风起,“金色圆环”满活力
面积最大的国家:俄罗斯
隔夜的豆角能吃吗?豆角隔夜储存指南
AI矩阵技术:深度解析与应用前景!
夫妻离婚后如何变更房产证姓名
碳碳双键红外峰位置及其应用
中国古玩行的乱象:互相欺骗与掩耳盗铃的悲歌
隧道盾构法施工技术研究
海豹突击队和三角洲部队谁更强?
李白:诗仙的传奇人生与艺术成就
黑猩猩手指现人类特征,进化之路能否延续?
可观测可视化 Grafana 版