SuperAPI AI 工具集

pr-description

写作与研究

查看项目

更新于 10-16 01:18

技能介绍

PR Description 是一个写作类技能,用途是把一次代码变更转化为结构化的 PR 描述,让评审者先理解意图再读 diff,从而加快评审、减少反复沟通。

主要能力:根据提供的变更内容,生成包含 PR 标题、What & why(问题与改动目的,可链接 issue)、Changes(关键改动要点,不逐文件罗列)、How it was tested(新增/更新的测试、手动验证与边界情况)、Risk & rollout(影响范围、迁移、开关、配置、向后兼容与回滚方式)、Reviewer guide(从哪看起、重点审查什么、明确不在范围内的内容及后续计划)以及截图或输出(涉及 UI 或用户可见变更时的前后对比)。

使用方式:需要提供变更内容(diff 摘要、提交或描述)、改动原因(解决的问题或链接的工单)、测试方式(如何验证)、风险与上线信息(影响范围、迁移、开关、兼容性、回滚)。若未提供,技能会先询问这些输入。输出遵循简洁、命令式的标题风格,例如 "Add rate limiting to the login endpoint";描述长度与变更规模成比例,一行修复用简短描述,大改动才展开完整结构。

适用场景:在打开拉取请求时使用,尤其适合需要清晰传达意图、测试证据与风险的团队协作。

限制与质量要求:不要只粘贴提交列表,要说明 diff 无法传达的意图;不要只说“已测试”而不说明方式;不要隐藏风险或迁移;不要为一行的改动写长篇;不要省略“重点看什么”。资料未提供具体的安装命令、平台支持、收费或价格信息。