Agent-Skills.md

Agent Skills: GitHub CLI Skill

使用 GitHub CLI 与 GitHub 资源交互；适用于 repo、issue、PR、comment、release、workflow 等查看、更新或创建场景。

UncategorizedID: dcjanus/prompts/github-cli

Repository

dcjanus/prompts
DCjanus
183

Install this agent skill to your local

pnpm dlx add-skill https://github.com/DCjanus/prompts/tree/HEAD/skills/github-cli

Skill Files

Browse the full folder contents for github-cli.

Download Skill

Loading file tree…

skills/github-cli/SKILL.md

Skill Metadata

Name
github-cli
Description
使用 GitHub CLI 与 GitHub 资源交互；适用于 repo、issue、PR、comment、release、workflow 等查看、更新或创建场景。

GitHub CLI Skill

一句话说明：当任务核心是“和 GitHub 打交道”时，优先使用 gh，而不是把范围局限在 Issue/PR。

常用场景

  • 仓库、Issue、PR、评论、release、workflow 等资源，优先先用 gh <group> --help 确认是否有现成子命令，再执行。
  • 需要机器可读输出时，优先使用 --json，必要时再配合 jq 整理字段。
  • 用户明确要求调整 repository merge / squash 策略时，参考 squash-merge-policy.md。

PR Review

  • 先看 PR 概览，再拉取 review / comment / thread 明细，确保不是只看单一来源。
  • 必要时可以查看本地对应分支的代码；查看前先 git fetch，确保分支是最新远端状态。
  • 当用户要求整理 PR 审查意见时，按严重程度从高到低排列，数字编号，方便用户回复。
  • 每次最多展示 10 条；若还有更多，在末尾提示“还剩 N 条未展示”。
  • 当用户要求回复 inline review comment 时，优先直接在线程里回复，不要把具体回复散落到总评论。
  • 对已经完成的小改动，回复保持简短，优先使用 “Added in b771da1ea.” / “Moved in b771da1ea.” / “Adjusted in b771da1ea.” 这类句式；commit 链接优先使用 [short_sha](full_commit_url) 形式，而不是笼统的 [commit]。
  • 除非需要解释设计取舍或说明暂不修改的原因，否则不要在 inline reply 里重复 reviewer 原文或写过长说明。

快速查看

  • 仓库概览：gh repo view [owner/repo]
  • Issue 概览：gh issue view <id|url>
  • PR 概览：gh pr view <id|url>
  • Release 列表：gh release list
  • Workflow 列表：gh workflow list

创建前检查

在创建 Issue 或 PR 前，先检查对应的 GitHub 模板、表单和当前资源状态。

  1. 优先检查 issue / PR form 模板，以及 .github/ISSUE_TEMPLATE/、.github/ISSUE_TEMPLATE.md、.github/PULL_REQUEST_TEMPLATE.md、.github/pull_request_template.md、.github/PULL_REQUEST_TEMPLATE/、.github/config.yml 等 GitHub 专用配置。
  2. Issue/PR 标题与正文编写统一遵循 SKILL.md。
  3. 在正式创建前检查当前代码、分支与提交状态是否和准备提交到平台上的内容一致，避免创建出与现状不符的 Issue 或 PR。

创建 Issue（非交互）

以下规范建立在“创建前检查”已完成的前提上。

  1. 标题与正文先按 SKILL.md 准备。
  2. Issue 正文默认先写到本地 Markdown 文件；草稿优先放 /tmp/*.md，标题通常较短，可直接用 --title 传入。
  3. 创建与修改时优先使用 --body-file，例如：gh issue create --title "..." --body-file /tmp/issue-body.md，或 gh issue edit <id> --title "..." --body-file /tmp/issue-body.md。
  4. 创建成功后，输出完整 Issue URL。

创建 PR

以下规范建立在“创建前检查”已完成的前提上。

  1. 先完成“创建前检查”。
  2. 只有在确认仓库要求与本地代码/提交状态都满足后，才创建 PR；若发现不满足，应先修正，再创建。
  3. git status 必须干净，且当前分支已推送到远端。
  4. 标题与正文先按 SKILL.md 准备。
  5. PR 正文默认先写到本地 Markdown 文件；草稿优先放 /tmp/*.md，不要在 shell 里拼多行字符串，也不要依赖交互式编辑。标题通常较短，可直接用 --title 传入。
  6. 创建 PR 时优先使用 --body-file，例如：
gh pr create \
  --title "feat(scope): short summary" \
  --body-file /tmp/pr-body.md \
  --base main \
  --draft
  1. 修改 PR 时也复用本地文件，避免手工编辑，例如：gh pr edit <id> --title "..." --body-file /tmp/pr-body.md。
  2. 创建成功后，输出完整 PR URL。

更新 Issue/PR 标题或描述（前置要求）

在更新 Issue 或 PR 的标题/描述之前，必须先读取当前标题/正文（即将被修改的内容），再进行修改。 更新标题或正文时，文案仍按 SKILL.md 重新生成。

冷门参数怎么查

  • gh --help
  • gh <group> --help
  • gh <group> <subcommand> --help