git-commit-doc
Installation
SKILL.md
Git Commit Doc
Overview
使用中文 Conventional Commits 风格编写提交说明:标题保持 type(scope): 中文一句话,正文用中文短横线列表说明关键变更。该规范从 xintong-java 的提交历史中提炼,但应作为全局通用提交文档使用。
Workflow
- 先检查未提交改动,优先读取 staged diff;如果没有 staged 内容,再读取 working tree diff,并明确说明提交文档基于哪部分改动生成。
- 如果 staged 和 unstaged 同时存在,默认以“全部未提交改动”为目标生成提交文档,除非用户明确要求只看 staged 或只看某些文件。
- 选择一个最准确的
type,不要为了显得完整拆成多个 type。 - 选择一个简短
scope,优先用业务域、模块名、配置域或主要类名。 - 用中文写一句标题,说明本次提交完成了什么,不写句号。
- 如变更超过一个要点,添加空行和
-开头的中文正文列表。 - 先直接返回完整提交文档,并明确询问用户是否按这版提交。
- 如果用户确认,直接使用这版文案执行提交。
- 如果用户不满意并给出手动修改版,默认以用户提供的版本作为最终文案,再做一次提交确认;确认后按用户版本执行提交。
- 不要把提交说明包进 Markdown 代码块,除非用户明确要求输出为代码块。