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 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:

  1. Metadata: gh repo view <owner/repo> --json name,description,stargazerCount,forkCount
  2. Structure: gh api repos/<owner/repo>/contents/
  3. Identity: Read the project manifest (e.g., package.json, go.mod, pyproject.toml) and README.md.
  4. 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:

Related skills
Installs
8
GitHub Stars
1.6K
First Seen
14 days ago