SuperAPI AI 工具集

pr-descriptions

编程与开发

查看项目

更新于 11-16 16:09

技能介绍

PR Descriptions 是一个面向 GitHub 拉取请求描述的写作技能,触发场景包括用户要求撰写、生成、更新或修正 PR 描述。

用途与结构:每个逻辑变更单独成节,标题为“## Change N: <Short Title>”。每节包含两行行为说明:Current way(当前方式,一句话说明今天的行为)和 New way(新方式,一句话说明本 PR 之后的行为)。随后是“### What To Test”测试清单,使用复选框列出以动作动词开头的步骤(如创建、打开、提交、取消勾选),并以“Confirm”开头的步骤确认可观察结果,同时覆盖正常路径与关键边界情况。

规则要求:行为说明只用通俗英文描述用户可见行为,不写代码或实现细节;测试步骤以动作动词开头;确认步骤以 Confirm 开头;不写填充内容,不使用 Overview 或 Summary 标题,直接进入变更内容。

工作流:撰写新描述时,先通过 gh pr view <number> --json files,commits,body 读取 diff,识别逻辑变更并分段,然后通过管道把正文传给 gh pr edit <number> --body-file - 发布(并说明内联 --body 在多行或特殊字符下会出问题)。更新已有描述时,先获取当前正文;保留所有已勾选的 - [x] 复选框和作者或评审人手动添加的内容;合并新变更时新增 Change 节和测试步骤;只替换先前运行中自己生成的内容,再发布合并结果。

图片:嵌入截图或前后对比图时,先用浏览器自动化工具生成图片(如对运行中的应用执行 agent-browser screenshot,并查阅项目文档了解本地登录流程),或使用用户提供的图片;然后把绝对路径传给 github-image-upload 技能,获得可内联粘贴的 github.com/user-attachments URL(私有仓库图片保持私有)。

分类与限制:资料未提供该技能的具体实现代码、安装方式、平台要求、收费信息或效果数据,这些内容暂未提供。