Skip to content

推荐的提交信息规则 ​

目标读者:希望 AI 与团队按同一套格式写 git 提交信息的用户。本文是作者自用提交信息规则的整理版,可直接复制到你的 agent 全局 rules(如 Trae 的规则、Claude Code 的 CLAUDE.md、通用的 AGENTS.md)。与推荐的 AI 全局规则相互独立,可只取其一。

解决什么问题 ​

AI 生成的提交信息常见两类毛病:写成英文格式头(feat:、fix:)导致中文项目历史风格断裂;或只罗列改了哪些文件,说不出这次改动解决了什么。本规则用一份类型字典加正反示例把格式与语义同时定住。

规则全文(可直接复制) ​

markdown
> 规则更新时间 2026-09-14 13:22。本规则内容变更时以变更时刻更新此值;快照与本页当前值不一致即说明已失同步,重新复制本页即可。

## 提交信息规则

### 要求

- 标题**全中文**,禁止英文格式头(feat:、fix: 等)
- 格式:`类型:描述`,全角冒号":"
- 标题为祈使句、30 汉字内、句末不加句号
- 包名/API 名等专有名词可保留英文
- 复杂改动:标题后空一行,用"- "列表说明变更点和原因(可选)

### 类型字典

| 类型 | 适用场景                                         |
| ---- | ------------------------------------------------ |
| 新增 | 新功能、新文件、新依赖                           |
| 修改 | 修改已有功能、调整逻辑、替换内容                 |
| 修复 | 修复 Bug                                         |
| 优化 | 性能、体验、样式、配置、结构调整、依赖升级等改动 |
| 清理 | 删除无用代码、清理依赖                           |
| 文档 | 更新文档、注释                                   |

### 示例

- ✅ 新增:新增数据导出功能
- ✅ 修改:修改审批流程逻辑
- ✅ 修复:修复金额计算精度丢失
- ✅ 优化:升级构建工具链至最新版本
- ✅ 清理:清理无用依赖和冗余代码
- ✅ 文档:补充接口调用说明文档

### 正文示例(可选)

```
优化:优化列表滚动加载性能

- 改用虚拟滚动,减少首屏渲染节点数
- 增加请求缓存,避免重复加载
```

### 反面示例

- ❌ fix: update some code(英文格式头)
- ❌ 更新了 index.ts 文件(只罗列文件,未说明动作)

为什么单独成页 ​

本文与推荐的 AI 全局规则各段性质不同:那份规则里的代码规范、输出要求、工作流都是给 AI 追加纪律,与团队既有工程惯例不冲突,采用是纯增益;本文是替换既有提交惯例——多数团队已有 feat: / fix: 英文格式头(Conventional Commits)或 commitlint 这类既有约定,与本规则直接互斥。因此单独成页:想用的人复制本页即可,不需要的人整页跳过,也不影响另一份规则的采用与更新。

相关页面 ​

MIT 开源协议