SuperAPI AI 工具集

create-pr

通用与其它

查看项目

更新于 10-15 21:51

技能介绍

用途:按 Sentry 工程实践创建 Pull Request,资料强调创建 PR 时必须使用该技能,不要直接创建。

前提:需要已认证且可用的 GitHub CLI(gh)。创建前确保所有改动已提交;若有未提交改动,先运行 sentry-skills:commit 技能提交。可用 git status --porcelain 检查。

流程:一、验证分支状态,用 gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name' 检测默认分支,再用 git status 与 git log $BASE..HEAD --oneline 确认改动已提交、分支与远端同步、必要时已基于基线分支变基。二、分析变更,用 git log $BASE..HEAD 与 git diff $BASE...HEAD 了解范围与目的。三、撰写描述,结构为:PR 做什么、为什么做、考虑过的替代方案(如有)、评审者需要的额外上下文;不要写测试计划、测试步骤复选框或重复的 diff 摘要;应包含清晰说明、相关 issue 链接、代码中不明显的上下文、需重点评审的说明。四、创建 PR,使用 gh pr create --draft --title "<type>(<scope>): <description>" --body "$(cat <<'EOF' ... EOF )",标题遵循提交约定,如 feat(scope): Add new feature、fix(scope): Fix the bug、ref: Refactor something。

issue 引用:Fixes #1234 合并时关闭 GitHub issue;Fixes SENTRY-1234 关闭 Sentry issue;Refs GH-1234 仅链接不关闭;Refs LINEAR-ABC-123 链接 Linear issue。

准则:每个功能或修复一个 PR,不捆绑无关改动;保持 PR 可评审,越小评审越快越好;解释为什么;尽早用草稿 PR 获取反馈。

编辑已有 PR:用 gh api 而非 gh pr edit,例如 gh api -X PATCH repos/{owner}/{repo}/pulls/PR_NUMBER -f body=... 或 -f title=...;资料说明 gh pr edit 因 GitHub Projects (classic) 弃用而暂时不可用。

限制:资料未提供该技能的安装方式、支持平台、收费与效果信息。