评论撰写器(友好协作评论)
编写温暖、直接、有用的协作评论,适用于 PR 反馈、问题回复和团队消息。
技能本身无网络访问、无需外部依赖,只提供文本写作指导和一条只读的 PR 检查命令;未要求用户确认,但作用范围限为写作,不涉及敏感数据处理或外部副作用。扣分:用户确认机制缺失,数据流透明度有限(命令为只读,但未说明输出用途),且作者身份未经验证,归属不明确。
指令自洽,示例清晰,但未提供测试或可执行验证;命令依赖 GitHub CLI,且未提供异常输入处理或失败反馈机制。扣分:关键路径未经复现,异常场景和错误提示缺失。
适用场景明确(PR 评论、issue 回复等),触发描述具体,但未明确声明能力边界和非适用场景;未提及中国网络可达性(本技能依赖本地 CLI 和用户上下文,不依赖海外服务,故未扣分)。扣分:边界和触发条件不完整。
文档结构清晰,有版本和元数据,但缺少安装/依赖说明、FAQ、已知限制和变更日志;license 与其他文件不一致(SKILL.md 声明 Apache-2.0,仓库为 MIT),归属仅作者名。扣分:治理信息不完整,license 冲突。
价值主张清晰,示例输出可直接使用,但缺乏对照评估或代表性输出验证;命令可能不适用于所有 PR 场景。扣分:静态评估无法验证实际效果,且输出完整性证据不足。
无测试、CI 或第三方证据支持技能本身;命令基于通用工具,但无实际运行记录。扣分:关键主张无内部测试或独立验证。
- 本技能为静态文本指导,无测试或执行验证,实际效果未经验证。
- PR 检查命令依赖 GitHub CLI,非所有环境亦可用;异常时无明确错误提示。
- 能力边界未声明,可能被误用于不适合的场景。
- license 声明与仓库不一致,SKILL.md 为 Apache-2.0,仓库为 MIT,需确认归属。
- 作者未经验证,维护责任和更新路径不明确。
这个 Skill 能做什么,适合哪些场景?
该技能指导 AI 代理为需要人类阅读的评论(如 GitHub PR 评论、问题回复、审查意见、Slack 消息和异步项目更新)编写清晰、温暖且直接的消息。它强调快速提供可操作要点、简洁性以及解释变更原因,同时避免不必要的细节。该技能提供一套语音规则、一个三部分评论公式(直接观察、原因和后续步骤)以及针对不同场景(如请求变更、批准和拆分 PR)的示例。
该技能读取目标上下文的语言来确定写作语言(例如,西班牙语问题用西班牙语,英语问题用英语),并应用一套语音规则。它指导代理使用评论公式:直接观察或请求、解释原因(如需要)和具体后续行动。它为请求更改、批准和拆分 PR 提供模板和示例。它还建议使用 gh pr view 命令检查 PR 详细信息的选项,但这并非强制要求。该技能不执行任何自动化操作,仅提供写作指南。
- 开发者在 GitHub PR 上提供审查反馈,希望提供有用且直接的评论,而不是冗长的总结。
- 维护者回复问题,需要简洁、温暖的回复,包含可操作的后续步骤。
- 团队成员在 Slack 或 Discord 上撰写异步项目更新,希望保持清晰和直接。
- 审查者要求更改,需要在不冗长的情况下解释技术原因。
- 开发者希望拆分一个大型 PR,需要建议逻辑拆分顺序。
这个 Skill 有哪些优点和局限?
- 提供清晰、可操作的指南,用于编写有效的协作评论
- 强调直接性和温暖,避免过多的技术术语
- 支持语言匹配(例如,西班牙语上下文用西班牙语撰写)
- 适用于多种通信平台
- 包含实际示例,说明如何请求更改、批准和拆分 PR
- 仅提供写作指南,不自动生成或发布评论
- 未包含测试套件或自动化验证
- 关于温暧与直接的规则实现可能因模型而异
- 未涵盖特定于平台的格式(例如,Markdown 表格或 Slack 块)
如何安装这个 Skill?
此技能包含在 Gentle-AI 存储库中,位于 internal/assets/skills/comment-writer/SKILL.md。要安装整个集合,请按照 README 中的 Gentle-AI 安装说明操作(例如,macOS/Linux 使用 curl -fsSL https://raw.githubusercontent.com/Gentleman-Programming/gentle-ai/main/scripts/install.sh | bash)。安装后,如果您的代理支持技能注册,该技能将自动可用。
如何使用这个 Skill?
在需要编写评论时,通过提及相关提示来加载技能,例如“为这个 PR 写一个友好的审查反馈”或“草拟一个回应这个问题的评论”。按照技能提供的语音规则和评论公式:从直接观察或请求开始,如有必要添加原因,并以具体后续行动结束。如果上下文是西班牙语,请默认使用中性/专业西班牙语撰写,除非另有要求。