SuperAPI AI 工具集

vibe-commit-message

编程与开发

查看项目

更新于 10-15 10:04

技能介绍

用途

vibe-commit-message 用于在撰写、修改、审阅或评判 Git 提交信息时提供指导,尤其针对提交正文、Conventional Commits、发布提交、依赖更新等场景。其核心理念是:提交信息应写给未来的智能体与维护者,而不是用来复述 diff。主题应说明提交达成了什么结果,正文则保留补丁本身无法可靠解释的上下文、需求、约束、权衡与有意排除的目标。

该技能把提交信息视为持久文本。在最终确定前,需要检查信息是否简洁、保留原意、语言得当、可独立理解、忠实于仓库模板、保留必要警告,并且不包含编造的上下文。

主要能力

  • 控制提交信息内容,但不干预仓库既有的暂存、提交、签名、发布与 Conventional Commits 规则。
  • 在未获用户或当前工作流授权时,不创建提交。
  • 提供信息价值分类:哪些内容应写入正文(如用户报告、生产症状、失败工作流、问题需求、发布约束、兼容性承诺、设计取舍、回滚标志、迁移路径、破坏性变更、已知限制、验证信号等),哪些应省略(如从 git show --stat、文件名或补丁即可看出的内容,测试文件名、单个测试用例、辅助函数名、逐行机制等)。
  • 提供消息结构建议:使用仓库的主题风格;对 Conventional Commits 推荐 type(scope): outcome 形式;使用文档化或近期历史中的类型值,若无本地列表则使用常见类型(feat、fix、refactor、perf、docs、test、build、ci、chore、style、revert),不发明 change 之类的通用类型。
  • 对非平凡提交建议使用带稳定标签的正文,仅包含有实际内容的部分:Context、Decision、Behavior、Compatibility、Verification、Out of scope。
  • 对小型提交建议使用短段落或不写正文;对机械同步、依赖升级、生成的锁文件更新等,优先仅写主题。
  • 处理提交 trailer(如 Co-Authored-By、Signed-off-by)时,要求放在正文之后、以空行分隔的最终 footer 块中。
  • 提供写作工作流:检查提交范围、识别未来读者可能的问题、判断多变更的聚合理由、从结果起草主题、从非 diff 上下文起草正文、删除可从 diff 恢复的内容、应用 fresh-clone-reader 测试、核实每项声明有据可依。
  • 针对常见提交形态给出指导:i18n/本地化、monorepo/多包、依赖更新、性能工作、CI/构建/发布自动化、安全/隐私/数据丢失修复、发布提交。
  • 说明应保留的内容:触发失败模式、调用方或用户影响、约束、所选设计、聚合理由、兼容性与逃生舱、有意排除项、验证信号。
  • 说明持久引用与验证来源的处理方式,以及应删除或压缩的内容。

使用方式

该技能以技能形式提供,具体安装命令与调用方式在现有资料中暂未提供。使用时,它会在撰写、修改、审阅或评判 Git 提交信息时生效,并遵循仓库既有的提交规范。

适用场景

  • 撰写或修改 Git 提交信息,尤其是需要保留非 diff 上下文的提交正文。
  • 审阅或评判已有提交信息。
  • 处理 Conventional Commits、发布提交、依赖更新等特定提交类型。
  • 处理 i18n/本地化、monorepo/多包、性能、CI/构建/发布、安全/隐私/数据丢失等常见提交形态。

限制

  • 该技能仅控制提交信息内容,不改变仓库的暂存、提交、签名、发布与 Conventional Commits 规则。
  • 除非用户或当前工作流已授权提交,否则不会创建提交。
  • 若现有证据无法解释变更存在的原因,不应编造动机;应基于可观察行为写更简短的信息,仅在提交信息会因此产生误导时才询问缺失上下文。
  • 不得编造测量数据、安全声明、发布状态、性能、兼容性等未经提供的内容。
  • 具体安装命令、调用方式、收费与价格信息在现有资料中暂未提供。