Codebase Orientation

Guide quick orientation of an unfamiliar codebase with module mapping, entry points, and local run steps. Use when a junior developer needs to get situated fast.

lidge-jun 413a77b 892 B Updated

File contents

Codebase Orientation

Inputs to request

  • Repo URL or local path and target area of interest.
  • Runtime versions, package manager, and OS.
  • Current task or reason for onboarding.

Workflow

  1. Locate entry points, build scripts, and main runtime paths.
  2. Map key folders, ownership, and common naming conventions.
  3. Identify how to run, test, and debug locally with minimal setup.
  4. Suggest one or two low-risk starter tasks.

Output

  • High-level module map with file paths.
  • Local run/test commands with prerequisites.
  • Suggested first change with low risk.

Quality bar

  • Reference concrete file paths and commands.
  • Keep scope limited to the requested area.

lidge-jun/cli-jaw-skills/tree/main/codebase-orientation commit 413a77b0e0

Frequently asked questions

npx skillmds@latest add lidge-jun/codebase-orientation