当前位置: 首页 > news >正文

git提交通用规范

提交类型

类型说明
feat新增功能或特性
fix修复Bug
docs文档更新(README、CHANGELOG、注释等)
style代码样式调整(空格、分号、格式等,不改变逻辑)
refactor代码重构(既非新增功能,也非修复Bug的代码修改)
test添加或修改测试用例
chore构建/工具/依赖变更(如修改CI配置、包管理器更新等)
perf性能优化
revert回滚某次提交

示例

1. feat - 新增功能

Java后端示例
feat(user): 新增用户角色权限管理接口- 添加RoleController的POST /role/assign接口
- 实现RBAC权限校验逻辑Related #45
前端示例
feat(order): 订单列表新增导出Excel按钮- 在OrderList.vue中添加导出按钮组件
- 调用/download/order-excel接口并处理文件流

2. fix - 修复Bug

Java后端示例
fix(auth): 修复JWT令牌过期时间计算错误原逻辑未考虑时区问题,导致实际过期时间偏差8小时
现改为使用UTC时间计算
前端示例
fix(table): 修复分页组件跳转页数失效问题当用户手动输入页码时,绑定值未正确更新
添加@change事件监听器强制刷新

3. docs - 文档更新

Java后端示例
docs(api): 补充支付模块Swagger注释- 添加PaymentController的@ApiOperation描述
- 明确@RequestParam取值范围说明
前端示例
docs(guide): 更新项目本地调试手册补充环境变量配置步骤:
1. 新增.env.development示例
2. 说明跨域代理配置方法

4. style - 代码样式

Java后端示例
style(service): 格式化UserService代码- 调整方法间空行间距
- 统一if括号换行风格
前端示例
style(login): 调整登录页CSS类名命名- 将.btn-login改为遵循BEM规范
- 删除未使用的!important标记

5. refactor - 代码重构

Java后端示例
refactor(order)!: 重构订单状态机实现BREAKING CHANGE: 
- 弃用LegacyOrderState枚举
- 迁移到新的OrderStateMachine引擎
前端示例
refactor(store): 将Vuex迁移至Pinia- 重构user模块为useUserStore
- 移除vuex依赖项

6. test - 测试相关

Java后端示例
test(utils): 添加StringUtils单元测试覆盖以下场景:
- 空字符串处理
- 特殊字符转义逻辑
前端示例
test(component): 为SearchBar添加E2E测试- 模拟用户输入和搜索按钮点击
- 验证结果列表更新逻辑

7. chore - 构建/工具

Java后端示例
chore(build): 升级Maven编译器插件至3.11.0- 修复JDK 21兼容性问题
- 更新CI中的mvn命令参数
前端示例
chore(deps): 更新axios到1.5.0版本解决安全警报CVE-2023-12345

8. perf - 性能优化

Java后端示例
perf(db): 优化商品查询SQL性能- 添加category_id索引
- 重写N+1查询为JOIN语句
前端示例
perf(assets): 实现图片懒加载- 使用IntersectionObserver API
- 首屏图片体积减少60%

9. revert - 回滚提交

Java后端示例
revert: 回滚"feat: 引入分布式锁实现"此次提交导致线程死锁问题,需重新设计This reverts commit 2s4d6f8a
前端示例
revert: 回滚"refactor: 升级Element Plus至2.4.0"新版存在表格渲染内存泄漏问题This reverts commit 9a3b7c2d

相关文章:

  • 阿里云国际版香港轻量云服务器:CN2 GIA加持,征服海外网络的“速度与激情”!
  • 掌握聚合函数:COUNT,MAX,MIN,SUM,AVG,GROUP BY和HAVING子句的用法,Where和HAVING的区别
  • 成功解决ImportError: cannot import name ‘DTensor‘ from ‘torch.distributed.tensor‘
  • 题目 3327: 蓝桥杯2025年第十六届省赛真题-倒水
  • loss的范围
  • 读《Go语言圣经》记录(一)
  • uni-app学习笔记十三-vue3中slot插槽的使用
  • QML与C++交互2
  • 【电子通识】连接器的绝缘胶座和接触端子基础知识
  • 数据结构 栈的详细解析
  • Java——优先级队列(堆)
  • 明阳智慧能源社招校招入职测评 |iLogic言语逻辑数字、Talent5大五职业性格测评、TAS倍智人才测评考什么
  • JVM规范之栈帧
  • 我的第1个爬虫程序——豆瓣Top250爬虫的详细步骤指南
  • uni-app学习笔记十二-vue3中组件传值(对象传值)
  • 字节跳动GPU Scale-up互联技术白皮书
  • 【数据结构】实现方式、应用场景与优缺点的系统总结
  • 基于Android的军训app的设计与实现
  • Leetcode 刷题记录 10 —— 二叉树
  • OpenGL环境配置
  • 杭州的服装网站建设/建站企业网站
  • 浅谈幼儿园网站的建设与管理制度/创意设计
  • 如何用word做网站/谷歌浏览器在线打开
  • 网站链接太多怎么做网站地图/bt种子万能搜索神器
  • 百度网站链接提交入口/企业自建网站
  • 宜宾做网站的公司/手游代理加盟哪个平台最强大