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 生成器)解析和处理提交记录。
通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。
热门推荐
NBA季后赛规则详解:从常规赛排名到总决赛
泰国游必学泰语问候语,避免文化尴尬
跨文化沟通:助你职场飞黄腾达!
语言教育:连接世界的桥梁
SHA-256算法的未来挑战:量子计算、密码学研究与算力提升
SHA-256:守护网络安全的加密利器
降央卓玛:藏语歌曲中的诗意与深情
软骨素的作用大揭秘:守护关节健康的秘密武器
氨糖软骨素的功效与使用注意事项
千年鹰笛:西藏音乐的灵魂
雪顿节上的西藏民歌:一场跨越千年的文化传承
2024年12月黄道吉日全攻略:16个幸运日等你来!
黄道吉日助你选个好日子出行!
春季出游黄道吉日指南:热门目的地、注意事项全攻略
中秋亲子DIY:花灯骨架制作指南
自贡花灯:八百年匠心传承,点亮世界文化舞台
65岁后多做这件事,有助长寿!
特斯拉被踢出ESG榜单,环保争议再起
哈佛商学院推荐:《总经理》必读
过年姐妹聚会:情感关系大挑战!
老有所依|70岁做“团长”、赴海外游学:新型老年旅游来了
全面体检必查的5个项目
逆火效应:与职场强势者沟通的正确姿势
与强势领导沟通的艺术:职场人必备的沟通技巧
物理专业就业指南:从新能源到互联网,六大领域全面解析
3万门票11分钟售罄,王者荣耀打造出“封神”年度总决赛
KPL梦之队选拔规则出炉:Gemini上榜,梦幻教练组要来了?
2024 年体育产业展望:热门职业的发展前景与机遇
天津理工大学计算机科学与技术:以科研创新引领人才培养
天理大热门专业揭秘:AI、大数据、云计算和区块链