Commit Message 规范

---

在日常开发中，良好的 Commit Message 能让代码历史更清晰，方便后续维护、回溯和生成更新日志。这里整理了一份 精简版规范，适合个人或小团队使用。

1. 常用前缀

• feat：新增功能
  例：feat(user): 新增用户头像上传

• fix：修复 bug
  例：fix(auth): 修复 token 过期未刷新

• docs：文档相关（README、注释等）
  例：docs(readme): 更新安装说明

• style：代码格式（空格、缩进、分号等，不改逻辑）
  例：style: 调整 UserService 缩进

• refactor：代码重构（既不是新增功能，也不是修复 bug）
  例：refactor(order): 提取公共方法

• perf：性能优化
  例：perf(api): 提升列表查询性能

• test：新增或修改测试
  例：test(user): 添加用户注册单测

• build：构建系统或依赖相关修改（Maven、Gradle、npm 等）
  例：build: 升级 Spring Boot 插件版本

• ci：持续集成/部署配置改动（GitHub Actions、Jenkinsfile 等）
  例：ci: 修改 GitHub Actions 发布流程

• chore：杂项，不影响代码逻辑（如修改 .gitignore）
  例：chore: 更新 .gitignore 文件

• revert：回滚某次提交
  例：revert: 回滚 commit 1234abcd

---

2. 推荐格式

<type>(<scope>): <subject>

• type：上面的前缀（feat / fix / …）

• scope：可选，影响范围（如 user、order、auth）

• subject：一句话简短描述

---

3. 示例

feat(user): 新增用户登录接口
fix(order): 修复订单金额计算错误
docs(api): 更新用户接口文档
refactor(common): 重构工具类结构
perf(api): 优化分页查询 SQL
build: 升级 MyBatis 版本
ci: 调整流水线构建缓存策略
chore: 修改 .gitignore 文件
revert: 回滚上次错误提交