以下是 Git 提交信息中常用的类型格式:
主要类型(Conventional Commits)
| 类型 | 标识 | 说明 | 版本影响 | 示例 |
|---|---|---|---|---|
| 功能 | feat |
新增功能 | Minor 版本 (v1.2.0) | feat: 添加用户注册功能 |
| 修复 | fix |
修复 bug | Patch 版本 (v1.0.1) | fix: 修复登录验证错误 |
| 文档 | docs |
文档更新 | 不影响版本 | docs: 更新 README 安装说明 |
| 样式 | style |
代码样式调整(不影响逻辑) | 不影响版本 | style: 调整代码缩进格式 |
| 重构 | refactor |
代码重构(不修复bug也不新增功能) | 不影响版本 | refactor: 优化用户模块结构 |
| 测试 | test |
测试相关代码 | 不影响版本 | test: 添加登录功能单元测试 |
| 构建 | chore |
构建过程或工具变更 | 不影响版本 | chore: 更新依赖包版本 |
| 性能 | perf |
性能优化 | Patch 版本 | perf: 优化图片加载性能 |
| CI/CD | ci |
CI/CD 配置相关 | 不影响版本 | ci: 配置 GitHub Actions 工作流 |
| 构建系统 | build |
构建系统或外部依赖变更 | Patch 版本 | build: 更新 webpack 配置 |
| 回退 | revert |
回退之前的提交 | Patch 版本 | revert: 撤销 feat: 添加xxx功能 |
扩展类型(常用)
| 类型 | 标识 | 说明 | 使用场景 |
|---|---|---|---|
| 改进 | improvement |
改进现有功能 | improvement: 优化搜索响应时间 |
| 安全 | security |
安全修复 | security: 修复 XSS 漏洞 |
| 热修复 | hotfix |
紧急修复(生产环境) | hotfix: 紧急修复支付接口 |
| 发布 | release |
发布版本 | release: 发布 v1.2.0 版本 |
| 实验 | experiment |
实验性功能 | experiment: 尝试新的 UI 布局 |
| 本地化 | i18n |
国际化/本地化 | i18n: 添加法语翻译 |
| 依赖 | deps |
依赖更新 | deps: 升级 React 到 v18 |
| 配置 | config |
配置文件变更 | config: 更新数据库配置 |
Angular 风格扩展
| 类型 | 标识 | 说明 |
|---|---|---|
| 无障碍 | a11y |
可访问性改进 |
| 动画 | anim |
动画相关变更 |
| 数据库 | db |
数据库变更 |
| 部署 | deploy |
部署相关 |
特殊类型
| 类型 | 标识 | 说明 |
|---|---|---|
| WIP | wip |
进行中的工作(Work In Progress) |
| 初始提交 | init |
项目初始化 |
| 迁移 | migration |
数据库迁移或数据迁移 |
使用建议
- 基础项目:使用
feat、fix、docs、style、refactor、test、chore - 完整规范:加上
perf、ci、build、revert - 根据需要:添加扩展类型如
security、hotfix等 - 一致性:团队内部统一约定最重要
作用域(可选)
可以添加作用域以更精确描述:
feat(auth): 添加双因素认证fix(api): 修复响应超时问题docs(readme): 更新安装步骤