SuperAPI AI 工具集

leaving-pr-comments

编程与开发

查看项目

更新于 10-27 16:24

技能介绍

用途

该技能用于在 GitHub 上代表用户发表评论时,统一添加署名提示,并规范评论的写作与发布流程。它适用于所有由智能体代写的 GitHub 评论场景。

主要能力

  • 为每条代表用户发表的评论添加 GitHub NOTE 提示块,格式为:

[!NOTE] 🤖 <model> responding on behalf of <user>

  • 要求使用撰写评论的模型的已验证公开名称,以及用户的姓名或 GitHub 登录名。
  • 如果运行环境未暴露模型名称,则使用运行环境名称,不得猜测。
  • 发布前检查整条评论(包括引用文本和附件)是否包含密钥或隐私信息。
  • 将署名保留在 NOTE 块内,实际回复放在块外。上下文行必须以机器人表情开头。
  • 禁止添加水平线、Setext 下划线、标题、签名页脚或第二个署名。

使用方式

该格式适用于以下场景:

  • PR 顶层评论
  • 行内审查评论
  • 回复机器人或审查者
  • 在解决或驳回反馈前使用的书面说明

不适用于以下场景:

  • PR 描述
  • 提交信息
  • 用户明确要求原样发布且不加署名的文本

评论本身应使用直接风格:

  • 先给出结论。
  • 引用相关代码、行为、检查或复现步骤。
  • 保持简洁,避免填充内容、套话感谢或状态叙述。
  • 区分已验证事实与判断。

发布前预览最终 Markdown,确保引用和空行按预期渲染。发布后确认 GitHub 返回了评论或审查链接。只有在回复成功发布后,才解决审查线程。

适用场景

适用于需要代表用户在 GitHub 上发表评论的自动化或辅助流程,尤其是 PR 审查、反馈回复和审查线程处理。

限制

  • 不适用于 PR 描述、提交信息或用户明确要求不加署名的原样发布文本。
  • 如果运行环境未暴露模型名称,只能使用运行环境名称,不得猜测。
  • 发布前必须检查密钥和隐私信息。
  • 发布后必须确认 GitHub 返回评论或审查链接。
  • 解决审查线程必须在回复成功发布之后。