github-codebase-briefing
Installation
SKILL.md
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
ghCLI. - 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) andREADME.md. - Entry Point: Read the primary entry file (e.g.,
index.ts,main.go) to identify the Public API surface.