# git-conventional-commit

**Repository Path**: trium/git-conventional-commit

## Basic Information

- **Project Name**: git-conventional-commit
- **Description**: 开源项目的 Git Commit 规范（Conventional Commits）
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-25
- **Last Updated**: 2026-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# git conventional commits
git 提交: 规范速查表

## 一、核心 Type 全集（开源/大厂通用）
| 类型 | 全称 | 作用说明 | 适用场景 |
|------|------|----------|----------|
| `feat` | feature | 新增功能 | 新增接口、组件、业务能力、API、新特性 |
| `fix` | fix bug | 缺陷修复 | 修复逻辑报错、线上Bug、兼容性、异常问题 |
| `refactor` | refactor | 代码重构 | 功能无变化、无Bug，仅优化代码结构、解耦、逻辑重构 |
| `perf` | performance | 性能优化 | 运行提速、算法优化、内存优化、打包体积压缩、缓存优化 |
| `docs` | documentation | 文档变更 | README、注释、类型说明、使用文档、文案修正 |
| `test` | test | 测试相关 | 新增/修改单元测试、E2E测试、Mock、测试用例 |
| `chore` | chore | 工程杂项 | 依赖升级、脚手架、Lint配置、脚本调整、不影响业务代码 |
| `ci` | CI config | 持续集成 | GitHub Actions、流水线、Jenkins、自动化部署配置 |
| `build` | build | 构建相关 | 打包配置、构建脚本、Rollup/Vite/Webpack 产物规则 |
| `style` | code style | 代码格式调整 | 缩进、空格、分号、格式化，**不影响业务逻辑** |
| `revert` | revert commit | 提交回滚 | 撤销历史某次 Commit 代码 |
| `release` | release | 版本发布 | 迭代版本号、打 Tag、正式发版 |

## 二、扩展补充类型（主流开源项目常用）
| 类型 | 使用场景 |
|------|----------|
| `types` | 仅 TypeScript 类型定义修正、类型补充与优化 |
| `improve` | 现有功能体验优化，不属于新功能、不属于Bug修复 |
| `wip` | 开发中临时提交，禁止合并至主干分支 |
| `merge` | 分支合并专用提交记录 |

## 三、标准 Commit 格式模板
```text
<type>[可选 scope]: <简短描述>

# 可选：详细正文，说明改动原因、影响、注意事项

# 可选：关联工单 / Issue
Closes #123
Fix #456

# 常用 Scope 作用域（模块标识）
通用：core、utils、cli、plugin
前端：router、store、components、hooks
工程：bundle、config、deps
```

## 四、示例
```text
feat(router): 新增路由全局守卫
fix(parser): 修复特殊字符解析报错
```

```text
feat(core): 新增资源预加载能力
fix(plugin): 修复多插件并行加载冲突
refactor(utils): 拆分通用工具方法，降低耦合
perf(bundle): 压缩产物体积，提升加载速度
docs: 更新安装与快速开始文档
chore: 升级项目依赖版本，修复版本冲突
ci: 调整自动化构建触发分支规则
build: 优化打包输出目录与模块化格式
revert: 回滚缓存策略变更提交
release: v1.3.0
```

## 五、极简记忆口诀
- 新增功能 → feat
- 修复问题 → fix
- 代码重构 → refactor
- 性能提升 → perf
- 文档修改 → docs
- 测试代码 → test
- 工程配置 → chore / build / ci
- 回滚代码 → revert
- 版本发版 → release

## 六、规范红线（禁止写法）
- ❌ 无类型纯文案：修复首页卡死问题
- ❌ 描述冗长、结尾带句号、大小写混乱
- ❌ 混用无关改动，一次 commit 做多件事
- ✅ 统一小写开头、动词先行、短句简洁、单一职责