SuperAPI AI 工具集

git-commit

编程与开发

查看项目

更新于 11-12 17:16

技能介绍

用途

git-commit 是一个用于约束 Git 提交行为的 AI 技能。当用户提出提交(commit)、创建提交、保存工作,或使用“커밋”这一韩语表述时,该技能要求助手按本规则生成提交,并声明会覆盖默认的 git commit 行为。

主要能力

  • 统一提交格式:提交信息为 emoji type(scope): subject,由 emoji、类型、范围(kebab-case)和主题四部分组成。
  • 类型与 emoji 映射:核心类型包括 feat(✨)、fix(🐛)、docs(📝)、style(💄)、refactor(♻️)、perf(⚡️)、test(✅)、chore(🔧)、ci(🚀)、revert(⏪️);资料还给出大量细分场景的 emoji,例如并发、SEO、国际化、可访问性、安全修复、依赖增删、数据库变更、快照测试等。
  • 写作规则:主题使用祈使语气(add 而非 added)、首行 ≤ 72 字符、结尾不加句号、避免含糊措辞(如 update、improve)。
  • 破坏性变更:在类型/范围后加 !,或在正文中使用 BREAKING CHANGE 脚注。
  • 提交粒度:默认“一个任务/请求对应一个提交”,不按文件、不按变更类型机械拆分;仅在混入真正无关事项时才拆分为 2–3 个提交。
  • 结果导向:提交信息只描述最终代码变更,不记录开发过程中的反复修复。
  • 评审修复提交:针对 PR 评审意见的修复有专门模板,可在正文中标注所回应的评审评论编号。
  • 语言一致性:提交前用 git log --oneline -5 查看仓库既有提交语言,按相同语言撰写提交信息。

使用方式

资料给出的快速流程:

  1. 检查项目约定:cat AGENTS.md 2>/dev/null | head -30 || cat CLAUDE.md 2>/dev/null | head -30。
  2. 查看暂存变更:git diff --staged --stat 与 git diff --staged。
  3. 必要时暂存文件:git add。
  4. 创建提交,例如:git commit -m "✨ feat(scope): add new feature"。
  5. 复杂变更可用 HEREDOC 写入多行正文:
git commit -m "$(cat <<'EOF'
✨ feat(scope): subject

Body explaining WHY and HOW.
Wrap at 72 characters.

Refs: #123
EOF
)"

提交前检查清单包括:相关文件是否全部纳入、信息是否干净且无重复的“fix/modify”、总结的是否为相对上一提交的 diff 而非对话日志。

Git 身份

使用有效 git config(git config user.name、git config user.email)提交;除用户明确要求外,不设置或覆盖 user.name/user.email;若有效邮箱与远程主机不匹配,应停止并询问后再提交。资料还说明在 GitHub 远程 URL 与链接中使用 Changroro,提交显示名不同是有意为之。

适用场景

适用于使用 AI 编程助手进行日常开发、希望提交记录遵循 Conventional Commits 并带 emoji 标注的项目;也适合需要按功能整体回滚(一个提交即可完整还原某项请求)的团队协作流程。

限制与约束

  • 资料以规范说明为主,未提供安装命令、插件安装步骤、平台支持范围、收费或价格信息,这些暂未提供。
  • 明确的禁止项:不暂存密钥、凭据或大体积二进制文件;不使用含糊主题;不在提交信息中罗列过程步骤;主题不以句号结尾。
  • “一个任务一个提交”的粒度规则是该技能的强制约定,与按文件提交的常见习惯不同,使用时需注意。