read-github-issue

Read GitHub issue status, metadata, and comments via gh CLI.

2|Updated Aug 20, 2024
One-click install
npx skills add https://github.com/theZMC/dotfiles --skill read-github-issue-thezmc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: read-github-issue
Source: https://github.com/theZMC/dotfiles/tree/main/.agents/skills/read-github-issue
Command: npx skills add https://github.com/theZMC/dotfiles --skill read-github-issue-thezmc

SYSTEM DOCUMENTATION & REQUIREMENTS

## What problem does it solve? Reads a GitHub issue and reports its status, metadata, and discussion comments using the GitHub CLI (gh) without summarizing the issue body content. Use when the user asks to review, inspect, or summarize an issue.

## Core Features & Use Cases

  • Reads issue metadata such as number, title, author, state, labels, assignees, milestone, and body without altering it.
  • Lists and analyzes discussion comments to surface decisions, questions, and blockers for triage and review.
  • Checks linked development context (e.g., PRs, branches) to provide a connected workflow view.

### Quick Start Ask the AI to read a GitHub issue by providing the repository and issue number.

Frequently Asked Questions about read-github-issue

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

FAQPage Schema
How do I read a GitHub issue and its comments using the command line?

To read a GitHub issue, you can use the gh CLI to fetch issue metadata, status, and discussion comments verbatim. It retrieves the issue body, labels, assignees, and linked development context without summarizing the original content.

Can I view GitHub issue metadata and labels without checking out the repository?

Yes, you can view GitHub issue metadata by specifying the repository using the --repo <owner>/<repo> flag when not in a local git context. This allows you to fetch issue details and comments from any repository.

How do I triage GitHub issues for blockers and open questions?

Triage GitHub issues by reading and analyzing the discussion comments to surface decisions, questions, and blockers. The Skill lists all comments and checks linked development context like PRs and branches to provide a connected workflow view.

Does reading GitHub issues with gh CLI require local repository access?

Reading GitHub issues with gh CLI requires access to the repository and the gh CLI installed. It can infer the owner and repo from your local git context, or you can manually provide the repository identifier if you are outside a repo.

What is the best way to review a GitHub issue's full body content verbatim?

The best way to review a GitHub issue verbatim is to fetch the issue data via gh issue view, which reports the title, author, state, and body without altering or summarizing the text for accurate review and inspection.

Why does my GitHub issue review show linked PRs and branches?

Your GitHub issue review shows linked PRs and branches because the Skill checks the linked development context to provide a connected workflow view. This helps you understand the current progress and related code changes directly tied to the issue.