Git Commit Helper 是一个辅助生成 Git 提交信息的技能,其核心用途是分析 git diff,帮助用户撰写清晰、规范的提交信息。当用户请求帮助编写提交信息或审查暂存改动时,可以调用它。
主要能力 该技能依据 Conventional Commits 格式生成提交信息,格式为:<type>(<scope>): <description>,随后可选正文(body)和页脚(footer)。支持的提交类型包括:feat(新功能)、fix(缺陷修复)、docs(文档变更)、style(代码风格变更,如格式化、缺失分号)、refactor(代码重构)、test(新增或更新测试)、chore(维护任务)。
使用方式 快速开始流程包括:查看暂存改动(git diff --staged),然后由 Claude 分析 diff 并建议提交信息。分析改动时可使用的命令有:git status(显示变更文件)、git diff --staged(显示详细变更)、git diff --staged --stat(显示统计信息)、git diff --staged path/to/file(显示特定文件的变更)。交互式提交可使用 git add -p 进行选择性暂存,再用 git commit -m "type(scope): description" 提交。修改最近一次提交可用 git commit --amend,如需追加文件可先 git add forgotten-file.js 再 git commit --amend --no-edit。
提交信息规范 指南建议:使用祈使语气(如 "add feature" 而非 "added feature")、首行保持在 50 个字符以内、首字母大写、摘要结尾不加句号、在正文中解释原因而不仅是内容。应避免:模糊信息(如 "update" 或 "fix stuff")、在摘要中包含技术实现细节、在摘要行写段落、使用过去时。
多文件提交与破坏性变更 提交多个相关改动时,可在正文中列出要点,并标注破坏性变更。破坏性变更需清晰标示,例如使用 feat(api)!: restructure API response format,并在页脚写明 BREAKING CHANGE 说明及迁移指南。
适用范围与限制 该技能主要面向使用 Git 进行版本控制的开发者,适用于编写提交信息、审查暂存改动、组织多文件提交、标记破坏性变更等场景。其参考文件为 references/GIT_COMMIT.template.md,其中包含 Conventional Commits 格式模板、类型、范围和示例。最佳实践包括:原子提交(每次提交一个逻辑变更)、提交前测试、引用问题编号、保持聚焦、为人类可读而写作。提交信息检查清单涵盖类型是否合适、范围是否明确、摘要是否在 50 字符内且使用祈使语气、正文是否解释原因、破坏性变更是否标注、相关问题编号是否包含。关于该技能的收费、价格、平台支持等具体信息,资料暂未提供。