SuperAPI AI 工具集

github-awesome-copilot-git-commit

编程与开发

查看项目

更新于 10-16 06:08

技能介绍

用途

该技能面向 Git 提交与协作流程,目标是根据实际代码变更生成高质量的原子化 Conventional Commits,并辅助提交审查、校验、PR 与发布说明等环节。

主要能力

提交生成

  • 通过 git diff 分析当前工作区,通过 git diff --cached 分析已暂存变更,生成 Conventional Commit 信息。
  • 依据变更的真实意图推断最合适的提交类型,并在有助于理解时推荐合适的 scope。
  • 生成简短、命令式、不超过 72 字符的提交主题,主题末尾不加句号。
  • 可选生成说明“改了什么、为什么改”的提交正文,以及用于 issue 引用和破坏性变更的 footer。

提交审查

  • 在创建提交前审查未提交的 Git 变更。
  • 检测同一 diff 中混入的不相关改动。
  • 建议将大型改动拆分为多个原子提交,并解释为何应拆分。
  • 为每个逻辑变更分别生成一条 Conventional Commit。
  • 忽略纯空白改动,除非是有意为之。

交互式 Git 工作流

  • 暂存前审查 git diff,提交前审查 git diff --cached。
  • 建议应一起提交的文件,并推荐使用 git add -p 的暂存策略。
  • 帮助建立整洁的原子提交历史。

校验

  • 按 Conventional Commits 1.0.0 校验提交信息。
  • 检测错误的类型、scope、格式或语法,并给出改进建议。
  • 校验主题长度、检测非命令式主题、检测不必要的 scope。

Pull Requests

  • 从提交生成 PR 标题与简洁的 PR 描述。
  • 总结主要变更、突出破坏性变更、列出测试说明、草拟审查者检查清单。

Releases

  • 生成 changelog 条目,将提交分组到发布类别。
  • 草拟发布说明,检测破坏性变更并生成迁移说明,总结显著改进。

使用方式

该技能以提示词(prompts)方式交互,典型用法包括:

  • 生成提交:“分析当前 Git 工作区,运行 git diff 并生成最佳 Conventional Commit。”“从当前未暂存变更生成 Conventional Commit。”“从 git diff --cached 生成 Conventional Commit。”
  • 从给定 diff 生成提交:“根据此 Git diff 生成 Conventional Commit。”“分析此 patch 并创建最佳 Conventional Commit。”“判断此变更的意图,而不是描述被修改的文件。”“编写包含正文和 footer 的完整多行 Conventional Commit。”
  • 提升提交质量:“推荐更好的提交 scope。”“建议更短的提交主题。”“按 Conventional Commits 重写此提交信息。”“解释为什么此提交应拆分。”
  • Git 工作流:“在我提交前审查我的 Git 变更。”“建议使用 git add -p 的整洁暂存策略。”“识别不相关的修改。”“推荐最佳提交顺序。”
  • 校验:“校验此 Conventional Commit。”“解释为什么此提交信息无效。”“按 Conventional Commits 1.0.0 重写此提交。”
  • PR:“从这些提交生成 PR 标题。”“生成完整的 PR 描述。”“为审查者总结这些提交。”
  • 发布:“从这些提交生成 changelog 条目。”“为下一版本草拟发布说明。”“为破坏性变更生成迁移说明。”

适用场景

适合需要在日常提交中保持规范、原子与可读历史的开发者,以及在提交前需要拆分混杂改动、生成 PR 描述和发布说明的团队协作流程。

限制

当前资料未提供该技能的独立安装命令、代码实现细节、费用、平台支持范围或运行环境要求,这些信息暂未提供。