--- name: chinese-commit-message description: 在本仓库执行 git commit、整理提交说明或准备推送时使用,保持提交信息使用英文类型前缀加中文描述。 --- # 中文提交信息 ## 何时使用 - 用户要求提交、推送或整理 commit message。 - 你准备执行 `git commit`。 - 需要总结当前 diff 的提交说明。 ## 核心要求 1. 提交信息必须使用英文 type 加中文摘要,例如 `feat: 补齐后端 agent skill 规范`。 2. 常用 type 优先使用 `feat`、`fix`、`refactor`、`docs`、`chore`。 3. 不强制 scope;只有模块边界非常清楚时才使用 `feat(auth): ...`。 4. 标题部分使用简洁中文,直接说明改动,不写“修改一下”“更新代码”这类空泛描述。 5. 非 trivial 改动建议补中文正文,用扁平 bullet 按文件或内容块说明关键动作。 6. 正文与标题之间空一行;正文每条 bullet 对应一个独立文件或明确内容块。 7. 如果用户指定提交信息,优先尊重用户原意,只做必要格式整理。 ## 触达文件补齐 - 不要求为了提交信息单独全仓扫描。 - 提交前如果 diff 中的触达文件明显违反对应 skill 的触达补齐要求,应先修正当前相关链路,再整理 commit message。 - commit 正文应概括本次触达补齐,例如“补齐触达文件注释”“同步 README 目录说明”。 ## 推荐结构 ```text feat: 补齐后端 agent skill 规范 - .agents/README.md: 新增项目级 skill 索引和使用入口 - .agents/skills: 补充中文提交与注释同步规则 - AGENTS.md: 增加本地 skill 入口 ``` ## 不推荐写法 - `新增规则` - `feat: add skills` - `fix bug` - `update` - 复杂改动只有标题没有正文。 - 正文写成长段流水账或嵌套列表。 ## 落地检查 - type 是否合理。 - 中文摘要是否覆盖主改动。 - 是否需要正文。 - 正文是否按文件或内容块归纳。