按 Sentry 工程规范用 AI 自动生成代码评审请求

针对 Sentry 开发团队的代码评审需求,通过 GitHub CLI 自动化生成包含变更原因、替代方案及具体上下文的 Pull Request 描述,同时自动检查未提交更改并执行标准重写流程。

为什么需要这个技能

在 Sentry 开发中,PR 描述必须符合特定的工程规范,包括清晰的"为什么"而非仅描述"做了什么"。手动编写冗长的背景、替代方案或上下文容易出错且耗时。本技能利用 GitHub CLI 和 antigravity-awesome 工具集,自动从 Git 提交差异中提取信息,生成标准格式的 PR 正文。

适用场景

  • 已使用 gh 工具认证并准备好提交 PR 时。
  • 需要系统化处理 Git 差异(diff),避免手动复制粘贴描述文本。
  • 遵循 Sentry 代码评审指南,确保描述包含动机、相关链接(如 SENTRY-xxxx)及审查注意事项。
  • 需要反复使用的可重复 PR 写入工作流,而非临时手动编写。

核心工作流

  1. 准备分支状态:确保所有更改已提交。若有未提交更改,先运行 sentry-skills:commit 技能。检查 git status 确保分支与远程同步,必要时基于基分支重放。

    # Check for uncommitted changes
    git status --porcelain
  2. 分析变更范围:确认本次 PR 包含的所有提交及完整差异。

    # See all commits that will be in the PR
    git log BASE..HEAD
    
    # See the full diff
    git diff BASE...HEAD
  3. 生成 PR 描述:按规范填充标题和正文,包含变更原因、动机、替代方案(如有)及审查者需要的上下文。标题遵循 feat(scope):fix(scope): 约定。

  4. 创建 PR:使用 gh pr create --draft 发起请求,直接填入 AI 生成的描述内容。

    gh pr create --draft --title "<type>(<scope>): <description>" --body "$(cat <<'EOF'
    <description body here>
    EOF
    )"

    禁止内容:测试计划、复选列表或重复的 diff 摘要。 建议包含:明确解释、相关 Issue 链接、不明显于代码的上下文、需重点审查区域提示。

下载和安装

下载 pr-writer 中文版 Skill ZIP

解压后将目录放入你的 AI 工具 skills 文件夹,重启工具后即可使用。具体路径参考内附的 USAGE.zh.md

你可能还需要

暂无推荐