SuperAPI AI 工具集

write-pr

编程与开发

查看项目

更新于 10-15 21:04

技能介绍

用途:为 tldraw/tldraw 仓库提供撰写 pull request 标题与描述的参考标准,并在提交前对 diff 中新增的注释做一遍预检清扫。核心原则是“为评审者而写”:读者熟悉代码库架构但未读过你的代码或 diff,描述的任务是给出代码里读不到的框架性信息,随后尽快收尾。默认写短,长度与改动规模匹配;按由粗到细的倒金字塔组织,评审者可在任意处停下仍获得正确理解。

覆盖顺序:目标、动机与使用场景最先写;其次是解决方案的高层形态(行为与结构);再次是 API 设计与决策(新增或变更的公开接口、所选方案、排除的方案及原因、不确定之处);最后是必要的最小示例片段与细节。禁止逐文件复述 diff、生成只是重复签名或文件清单的表格、为显得完备而堆砌结构,也禁止编造动机——动机与取舍必须来自真实意图,不明时应询问用户。

标题:使用语义化格式 <type>(<scope>): <description>,type 含 feat、fix、docs、refactor、perf、test、chore,scope 为可选名词,如 fix(editor):、feat(sync):、docs(examples):。

正文:bugfix 与 improvement 类型使用固定的 Before/After 模板,包含一句简介、Before(原行为及产生症状的机制)、After(现行为)、可选 Implementation notes,以及 Change type、Test plan、Release notes、Code changes 等区块;其他类型使用“In order to X, this PR does Y.”开头的描述段加标准区块。涉及画布交互(拖拽、缩放、旋转、裁剪、手柄、工具手势)的改动,可在 Before/After 各放一段短录屏,脚本为 scripts/record-interaction.mjs,需 ffmpeg 与 Playwright Chromium,并先运行 pnpm exec playwright install chromium。

注释清扫:运行 git diff origin/main...HEAD -U0 | grep -nE '^+\s*(//|/*|*)' 检查新增注释,判断标准见根目录 AGENTS.md;好注释说明失败模式而非机制,常见缺陷是长度而非类别。

限制:本技能仅针对该仓库的 PR 写作,具体条款以仓库 AGENTS.md 为准;资料未提供其他平台的适用性说明。