Skip to content

Commit 4e7c16b

Browse files
CodeCasterXclaude
andcommitted
docs: 添加 Git 提交信息中文格式规范
- 新增规则 3:Commit Message 格式规范 - 要求提交信息核心内容必须使用中文 - 定义标准格式:<type>: <中文描述> - 列出所有 type 类型及其说明 - 引入子类型概念,如 chore(deps) 用于依赖升级 - 提供完整的示例和强制要求清单 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent 99b4a2c commit 4e7c16b

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

.claude/project-rules.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,69 @@ Bash("OWNER_GROUP=$(ls -l README.md | awk '{print $3\":\"$4}') && sudo chown $OW
189189
190190
## Git 提交和版本控制规范
191191
192-
### 规则 3: 禁止自动提交代码
192+
### 规则 3: Commit Message 格式规范
193+
194+
**⚠️ 重要规则(CRITICAL):**
195+
196+
本项目的提交信息**必须使用中文作为核心内容**,遵循以下格式:
197+
198+
**标准格式:**
199+
```
200+
<type>: <中文描述>
201+
202+
<可选的详细说明>
203+
204+
🤖 Generated with [Claude Code](https://claude.com/claude-code)
205+
206+
Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
207+
```
208+
209+
**Type 类型(使用英文):**
210+
- `feat`: 新功能
211+
- `fix`: Bug 修复
212+
- `docs`: 文档更新
213+
- `style`: 代码格式调整(不影响代码逻辑)
214+
- `refactor`: 重构(既不是新功能也不是 Bug 修复)
215+
- `perf`: 性能优化
216+
- `test`: 测试相关
217+
- `chore`: 构建过程或辅助工具的变动(包括依赖升级)
218+
- `revert`: 回滚之前的提交
219+
220+
**子类型(可选):**
221+
- `chore(deps)`: 依赖升级,格式:`chore(deps): 升级 <package> 到 v<version>`
222+
223+
**示例:**
224+
```bash
225+
# 新功能
226+
feat: 添加用户认证功能
227+
228+
# Bug 修复
229+
fix: 修复登录失败的问题
230+
231+
# 文档更新
232+
docs: 更新 API 文档
233+
234+
# 依赖升级
235+
chore(deps): 升级 fastjson2 到 v2.0.60
236+
237+
# 代码重构
238+
refactor: 重构用户服务模块
239+
240+
# 性能优化
241+
perf: 优化数据库查询性能
242+
243+
# 构建相关
244+
chore: 更新构建脚本
245+
```
246+
247+
**强制要求:**
248+
1. 描述部分**必须使用中文**
249+
2. Type 类型使用英文小写
250+
3. 描述要简洁明了,概括核心变更
251+
4. 多个变更应该分多次提交
252+
5. 必须在提交消息末尾添加 Claude Code 签名
253+
254+
### 规则 4: 禁止自动提交代码
193255
194256
**⚠️ 重要规则(CRITICAL):**
195257

0 commit comments

Comments
 (0)