agentleFS
Sign inStart free
WST2002WST2002/claude-code-skills/skills/codebase-onboarding/SKILL.md

codebase-onboarding

Skill4 starsChanged 27 days agoMITView on GitHub

Use when joining or exploring an unfamiliar codebase, asked to explain how a project works, where something is implemented, how to run it locally, or to create an onboarding guide for new team members.

  • Reads credentials

56 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use pytorch-patterns, continuous-agent-loop and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Yog-SothoSkill

    pytorch-patterns

    PyTorch deep learning patterns and best practices for building robust, efficient, and reproducible training pipelines, model architectures, and data loading. Always activate when the user is writing PyTorch models or training scripts, reviewing deep learning code, debugging training loops or data pipelines, optimizing GPU memory or training speed, setting up reproducible experiments, implementing transfer learning or fine-tuning, or asks anything about nn.Module, DataLoader, autograd, AMP, or torch.compile.

    Also in 6 projects that use this

  • junimnjwSkill

    continuous-agent-loop

    Patterns for continuous autonomous agent loops with quality gates, evals, and recovery controls.

    Also in 7 projects that use this

  • loulanyueSkill

    nuxt4-patterns

    Nuxt 4 app patterns for hydration safety, performance, route rules, lazy loading, and SSR-safe data fetching with useFetch and useAsyncData.

    Also in 4 projects that use this

  • Arnav-0Skill

    api-test-suite-builder

    Use when the user asks to generate API tests, create integration test suites, test REST endpoints, or build contract tests.

    Also in 3 projects that use this

  • royaluniondesign-sysSkill

    content-hash-cache-pattern

    Cache expensive file processing results using SHA-256 content hashes — path-independent, auto-invalidating, with service layer separation.

    Also in 5 projects that use this

  • junimnjwSkill

    carrier-relationship-management

    Codified expertise for managing carrier portfolios, negotiating freight rates, tracking carrier performance, allocating freight, and maintaining strategic carrier relationships. Informed by transportation managers with 15+ years experience. Includes scorecarding frameworks, RFP processes, market intelligence, and compliance vetting. Use when managing carriers, negotiating rates, evaluating carrier performance, or building freight strategies.

    Also in 4 projects that use this

  • +3 more from junimnjw

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 52 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When the user asks a narrower question ("where is checkout implemented?"), answer it directly with paths and a short flow, and skip the …

    line 49

“Common” is measured: kept by at least 6 in 10 of the 52 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Codebase Onboarding

Overview

Give a new developer a working mental model in minutes: what the project does, how it is organized, how a request flows through it, how to run it, and where to make common changes. Every claim points to a file.

Method

  1. Identify the project: README, manifests (package.json, pom.xml, pyproject.toml, go.mod), languages, frameworks, versions.
  2. Find how it runs: scripts, Makefile, docker-compose.yml, .env.example, CI workflow (the CI file shows the real build and test steps).
  3. Map the structure: top-level folders and what each owns. Find the entry points (server start, routes, CLI main, app root).
  4. Trace one real flow end to end: for example an HTTP request from route → handler → service → database → response, with file paths.
  5. Find the conventions: state management, data access, error handling, logging, testing style, naming.
  6. List the gotchas: required services, generated code, environment quirks, slow or flaky parts, areas without tests.
  7. Write the guide with the format below. Verify the run commands exist.

Output format

# <Project> — onboarding

## What it is
<2-3 sentences: purpose, users, main tech>

## Run it locally
<prerequisites, env setup, install, run, test commands — verified>

## Map
| Path | Responsibility |

## How a request flows
<numbered steps with file paths, or a Mermaid sequence diagram>

## Conventions
<how to add an endpoint / page / table here, with an example file to copy>

## Gotchas
<things that surprise newcomers>

## Where to start
<3 good first areas or files to read, in order>

When the user asks a narrower question ("where is checkout implemented?"), answer it directly with paths and a short flow, and skip the full guide.

Common mistakes

  • Describing the folder tree without explaining responsibilities.
  • Explaining frameworks in general instead of how this project uses them.
  • Listing commands from memory instead of from the scripts that exist.
  • Missing the one required service or environment variable that blocks first run.
  • Reading only the README, which is often out of date; trust code and CI first.

Made by Wageesha Tripathi · LinkedIn · Email · More skills

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free