GitHub Codebase Briefing
This skill performs a "deep read" of a repository. It avoids superficial listings by first understanding the project's architecture and then evaluating open items against that context.
Prerequisites
- Tooling: The agent must have access to the
gh CLI.
- Auth: The user must be authenticated (
gh auth status).
Instructions
Step 1: Initialize the Mental Model
Before looking at tasks, understand the environment. Run these commands in sequence:
- Metadata:
gh repo view <owner/repo> --json name,description,stargazerCount,forkCount
- Structure:
gh api repos/<owner/repo>/contents/
- Identity: Read the project manifest (e.g.,
package.json, go.mod, pyproject.toml) and README.md.
- Entry Point: Read the primary entry file (e.g.,
index.ts, main.go) to identify the Public API surface.
Step 2: Retrieve State & Delta
Fetch current items and recent changes:
- Issues:
gh issue list --repo <owner/repo> --state open --json number,title,body,author,createdAt,updatedAt,labels,comments
- PRs:
gh pr list --repo <owner/repo> --state open --json number,title,body,author,createdAt,updatedAt,labels,additions,deletions,changedFiles,headRefName
- 24h Delta:
gh issue list --state closed --since 24h and gh pr list --state merged --since 24h.
Step 3: Deep Analysis Logic
For every issue and PR, do not just summarize the text. Perform a logic check:
- Issues: Use
gh api repos/<owner/repo>/contents/<path> to inspect the code mentioned in the report.
- PRs: Use
gh pr diff <number> to review actual implementation. Evaluate if the code follows the patterns found in Step 1.
- Flags:
- 🚨 SECURITY: Scan for credentials, auth bypass, or injection keywords.
- 🤝 EXTERNAL: Prioritize PRs from non-maintainers.
- ✅ READY: Verify mergeability with
gh pr view <number> --json mergeable,statusCheckRollup.
Step 4: Pattern Synthesis
Group items into high-level insights:
- Bug Clusters: Identify if 3+ issues share a root cause in a specific module.
- Hot Modules: Flag files that appear in multiple open items.
- Client Patterns: Group issues by consumer (e.g., "VS Code users are reporting X").
Output Template
# {REPO_NAME} Daily Briefing — {DATE}
Snapshot: {N} Issues ({+X} since yesterday) | {M} PRs ({+Y} since yesterday)
⚡ Suggested Actions Today
- [Priority] #{Num}: {One-line reason}
- [Priority] #{Num}: {One-line reason}
📂 Open Issues Deep Dive
[Flag] #{Num} — {Title}
- Context: Plain-English explanation of the "why" and "where" in the codebase.
- Key Evidence: > {Blockquote of critical user text}
- Resolution Path: {Quick fix/Design decision/Blocked}
🔀 Pull Request Analysis
[Flag] #{Num} — {Title}
- Impact: Summary of files changed and architectural fit.
- Quality Note: Honest assessment of implementation and CI status.
🔍 Patterns & Health
- Hot Modules:
{list/of/files}
- Release Cadence: Last release was
{days} ago.
1---2name: github-codebase-briefing3description: Generates a deeply contextual, progressive-disclosure briefing for any GitHub repository. It builds a mental model of the code before analyzing issues and PRs to provide actionable insights. Use when asked for a "GitHub report," "repo status," "daily briefing," or to "catch up on a codebase."4license: MIT5---67# GitHub Codebase Briefing89This skill performs a "deep read" of a repository. It avoids superficial listings by first understanding the project's architecture and then evaluating open items against that context.1011## Prerequisites1213- **Tooling:** The agent must have access to the `gh` CLI.14- **Auth:** The user must be authenticated (`gh auth status`).1516## Instructions1718### Step 1: Initialize the Mental Model1920Before looking at tasks, understand the environment. Run these commands in sequence:21221. **Metadata:** `gh repo view <owner/repo> --json name,description,stargazerCount,forkCount`232. **Structure:** `gh api repos/<owner/repo>/contents/`243. **Identity:** Read the project manifest (e.g., `package.json`, `go.mod`, `pyproject.toml`) and `README.md`.254. **Entry Point:** Read the primary entry file (e.g., `index.ts`, `main.go`) to identify the Public API surface.2627### Step 2: Retrieve State & Delta2829Fetch current items and recent changes:30311. **Issues:** `gh issue list --repo <owner/repo> --state open --json number,title,body,author,createdAt,updatedAt,labels,comments`322. **PRs:** `gh pr list --repo <owner/repo> --state open --json number,title,body,author,createdAt,updatedAt,labels,additions,deletions,changedFiles,headRefName`333. **24h Delta:** `gh issue list --state closed --since 24h` and `gh pr list --state merged --since 24h`.3435### Step 3: Deep Analysis Logic3637For every issue and PR, do not just summarize the text. Perform a logic check:3839- **Issues:** Use `gh api repos/<owner/repo>/contents/<path>` to inspect the code mentioned in the report.40- **PRs:** Use `gh pr diff <number>` to review actual implementation. Evaluate if the code follows the patterns found in Step 1.41- **Flags:**42 - 🚨 **SECURITY:** Scan for credentials, auth bypass, or injection keywords.43 - 🤝 **EXTERNAL:** Prioritize PRs from non-maintainers.44 - ✅ **READY:** Verify mergeability with `gh pr view <number> --json mergeable,statusCheckRollup`.4546### Step 4: Pattern Synthesis4748Group items into high-level insights:4950- **Bug Clusters:** Identify if 3+ issues share a root cause in a specific module.51- **Hot Modules:** Flag files that appear in multiple open items.52- **Client Patterns:** Group issues by consumer (e.g., "VS Code users are reporting X").5354## Output Template5556### # {REPO_NAME} Daily Briefing — {DATE}5758**Snapshot:** {N} Issues ({+X} since yesterday) | {M} PRs ({+Y} since yesterday)5960### ⚡ Suggested Actions Today61621. **[Priority] #{Num}:** {One-line reason}632. **[Priority] #{Num}:** {One-line reason}6465---6667### 📂 Open Issues Deep Dive6869#### [Flag] #{Num} — {Title}7071- **Context:** Plain-English explanation of the "why" and "where" in the codebase.72- **Key Evidence:** > {Blockquote of critical user text}73- **Resolution Path:** {Quick fix/Design decision/Blocked}7475### 🔀 Pull Request Analysis7677#### [Flag] #{Num} — {Title}7879- **Impact:** Summary of files changed and architectural fit.80- **Quality Note:** Honest assessment of implementation and CI status.8182### 🔍 Patterns & Health8384- **Hot Modules:** `{list/of/files}`85- **Release Cadence:** Last release was `{days}` ago.