agentleFS
PradnyeshpPradnyeshp/Claude-Skills/.claude/skills/onboard/SKILL.md

onboard

Skill2 starsChanged 4 months agoMITView on GitHub

Orient a developer to an unfamiliar codebase — how to build and run it, the high-level architecture, key directories, and where to start. Use when the user says "help me understand this repo", "onboard me", "what is this project", "how do I run this", "give me the lay of the land", or "where do I start".

  • Reads credentials

171 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use soak-test, team-live-ops 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.
  • lilangMaxSkill

    soak-test

    Generate a soak test protocol for extended play sessions. Defines what to observe, measure, and log during long play sessions to surface slow leaks, fatigue effects, and edge cases that only appear after sustained play. Primarily used in Polish and Release phases.

    Also in 10 projects that use this

  • lilangMaxSkill

    team-live-ops

    Orchestrate the live-ops team for post-launch content planning: coordinates live-ops-designer, economy-designer, analytics-engineer, community-manager, writer, and narrative-director to design and plan a season, event, or live content update.

    Also in 10 projects that use this

  • HK-hubSkill

    teach-impeccable

    One-time setup that gathers design context for your project and saves it to your AI config file. Run once to establish persistent design guidelines.

    Also in 18 projects that use this

  • CoralGameSkill

    team-level

    Orchestrate level design team: level-designer + narrative-director + world-builder + art-director + systems-designer + qa-tester for complete area/level creation.

    Also in 12 projects that use this

  • CoralGameSkill

    playtest-report

    Generates a structured playtest report template or analyzes existing playtest notes into a structured format. Use this to standardize playtest feedback collection and analysis.

    Also in 12 projects that use this

  • HK-hubSkill

    arrange

    Improve layout, spacing, and visual rhythm. Fixes monotonous grids, inconsistent spacing, and weak visual hierarchy. Use when the user mentions layout feeling off, spacing issues, visual hierarchy, crowded UI, alignment problems, or wanting better composition.

    Also in 13 projects that use this

  • +5 more from lilangMax
  • +1 more from CoralGame

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 159 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read before asserting — open the entry point and a few key files.

    line 31
  2. Very specific:

    Prefer commands you can verify exist (in scripts/Makefile/CI) over invented ones.

    line 33
  3. Very specific:

    Keep it skimmable — headings, short bullets, a couple of file:line anchors.

    line 34
  4. Distinctive:

    Do not modify any files — this skill is read-only.

    line 35

“Common” is measured: kept by at least 6 in 10 of the 159 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

Project signals

!ls 2>/dev/null

!cat README* 2>/dev/null | head -60

!ls package.json pyproject.toml Cargo.toml go.mod pom.xml Makefile docker-compose.yml .env.example 2>/dev/null

Instructions

Produce a concise orientation guide to this codebase (focused on $ARGUMENTS if an area was named). This is for a competent engineer who has never seen this repo — help them become productive fast.

What to cover

  1. What it is — one paragraph: the project's purpose and what it does, inferred from the README, manifests, and entry points.
  2. Tech stack — languages, frameworks, runtime, datastore, and notable libraries, read from the manifests and config.
  3. How to run it — the actual setup, build, run, and test commands. Pull these from scripts in package.json, a Makefile, CONTRIBUTING docs, or CI config. Note required env vars (check .env.example) and services (e.g. docker-compose).
  4. Architecture map — the top-level directories and what each is responsible for. Identify the entry point(s) and trace the main flow at a high level (request → handler → service → data, or equivalent).
  5. Where to start — point to the 3–5 most important files to read first, and call out conventions a newcomer must know (testing approach, module boundaries, naming).

Rules

  1. Read before asserting — open the entry point and a few key files; don't guess the architecture from names alone.
  2. Cite real paths (src/server.ts:1) so the reader can jump straight there.
  3. Prefer commands you can verify exist (in scripts/Makefile/CI) over invented ones. If you can't confirm how to run it, say so and show your best guess clearly labeled.
  4. Keep it skimmable — headings, short bullets, a couple of file:line anchors. This is a map, not an essay.
  5. Do not modify any files — this skill is read-only.

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.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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.