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