| name | github-pr-issue |
| description | 查看/更新 GitHub Issue、PR(含评论与 diff),并按团队规范非交互创建或修改 PR;涉及 GitHub Issue/PR 的操作时使用。 |
GitHub CLI Skill(Issue/PR)
GitHub 链接快速查看
- 进入 Issue 前可先运行
gh api user --jq '.login',确认当前身份以辨识讨论中提到的用户是否就是自己。 - Issue:
gh issue view <url>;若需阅读评论,加--comments。 - PR 信息:
gh pr view <url>,同样使用默认输出即可,必要时可附加--comments、--files等参数按需展开。 - PR diff:
gh pr diff <url> --color never。
创建 PR
以下标题与描述规范为默认推荐格式;如与团队/仓库/平台等既有约束冲突,以既有约束为准。
- 确认
git status干净,git push到远端。 - 标题风格:英文、遵循语义化提交规范(如
feat(scope): short summary),保持简洁且描述核心目的。 - 描述风格:英文要点式,首段写最关键目标,再补充次要更新,必要时用列表清晰呈现,避免冗长叙述;若上下文不足以明确目的,应主动向开发者确认后再撰写。内容聚焦合并前后的行为/影响对比,避免记录开发过程中的中间尝试与撤销动作。
- 用非交互式命令创建 PR,正文统一通过
--body-file传入:gh pr new --title "feat(scope): short semantic summary" --body-file - <<'EOF' - Added X - Updated Y - Notes: Z EOF- 可追加
--base <branch>、--draft等参数。 - 多行正文只能通过
--body-file传入,避免在--body中写\n。
- 可追加
gh pr edit与gh pr new参数一致,需修改时复用。- PR 创建成功后,在终端单独输出 CLI 返回的完整 PR URL。