skills.rest
theZMC
theZMCCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

read-github-pr

Compile a structured GitHub pull request briefing from gh CLI metadata and comments.

2|Updated Aug 20, 2024
Search Tags:#github#pr#code-review#pull-request#summarize#gh-cli
One-click install
npx skills add https://github.com/theZMC/dotfiles --skill read-github-pr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: read-github-pr
Source: https://github.com/theZMC/dotfiles/tree/main/.agents/skills/read-github-pr
Command: npx skills add https://github.com/theZMC/dotfiles --skill read-github-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Quickly understand the key aspects of a GitHub pull request without opening it, by generating a concise summary of its description, status, commits, changed files, and discussion comments.

Core Features & Use Cases

  • PR metadata extraction: Retrieve number, title, author, state, base and head branches, and mergeability using the gh CLI.
  • Change and discussion summary: Aggregate commits, touched files, and inline discussions for quick reviews.
  • Use Case: When a product manager needs a briefing for a PR before a release, or a developer wants a fast recap for stakeholders.

Quick Start

Provide the repository and PR number or URL, and I will generate a structured PR summary.

Frequently Asked Questions about read-github-pr

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I summarize a GitHub pull request without opening it in the browser?▼

To summarize a GitHub pull request without opening a browser, provide the repository and PR number or URL. The tool fetches metadata, commits, changed files, and discussion comments via the gh CLI to generate a concise briefing.

Does this PR summarization tool work with the gh CLI to fetch review comments?▼

Yes, this PR summarization tool works with the gh CLI. It uses the `gh pr view` command to fetch PR metadata and body, and the `gh api` command to read review and discussion comments for the summary.

Can I get a quick PR briefing for stakeholders before a release?▼

Yes, you can get a quick PR briefing for stakeholders before a release. It compiles a structured report including the PR number, title, author, state, base and head branches, mergeability, commits, and touched files.

How does the tool identify the repository context for a pull request?▼

The tool identifies the repository context for a pull request by checking the git remote configuration when possible. It uses this to automatically determine the owner and repository name before fetching PR data.

What information is included in a GitHub pull request summary?▼

A GitHub pull request summary includes the PR number, title, author, state, base and head branches, mergeability status, commits, changed files, and discussion threads, providing a complete overview for decision making.

Related Skills

Explore More Software Engineering Skills→
JuanMS20JuanMS20

github-auth

Configure GitHub authentication for Hermes Agent using git, gh CLI, or SSH credentials.

Community
Intermediate
tiancaiamaotiancaiamao
5

land

Merge approved GitHub pull requests after CI checks pass and update task state.

Community
Advanced
peterfeipeterfei
420

changelog-generator

Generate CHANGELOG.md from Git commit history using Conventional Commits.

Community
Intermediate
DaddyElonMusk69DaddyElonMusk69

github-pr-workflow

Automate GitHub pull request creation, commits, and merging via CLI or REST API.

Community
Advanced