agentleFS
tejastn10tejastn10/workbench/skills/planning/orient/SKILL.md

orient

Skill1 starsChanged 2 months agoMITView on GitHub

Get up to speed in an unfamiliar codebase fast — find the entry points, trace the main data flow, learn the local conventions and the landmines, then write it down as the project's CONTEXT.md. Use when starting work in a repo you don't know, when asked to "explain this codebase" / "how does this project work", or before an agent's first task in a new project.

27 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use retro, ui-ux-pro-max and 1 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.
  • AWSSkill

    retro

    Conduct a retrospective on a coding session.

    Also in 3 projects that use this

  • StrayDragonSkill

    ui-ux-pro-max

    UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 8 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient.

    Also in 3 projects that use this

  • AWSSkill

    ship

    Finalize dev work on an issue branch — update docs, push, and open a PR.

    Also in 3 projects that use this

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

    Follow it: route → controller → service → repository → datastore.

    line 20

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

Orient in a codebase

Adapted in spirit from mattpocock/skills wayfinder. The output is a first-draft CONTEXT.md (CONTEXT.md (repo root) as the template) — the thing every later session needs.

Order of operations

  1. Read the README, then the package manifest. Stack, framework, package manager, scripts, key dependencies. Note the version-pin files (.nvmrc, .python-version, go.mod).
  2. Find the entry points. main.ts / main.go / app.module.ts / main.tsx. For a service: how does a request get from the edge to a handler?
  3. Trace one real flow end to end. Pick a representative endpoint or job. Follow it: route → controller → service → repository → datastore. Note the layers and where the boundaries are.
  4. Map the directories that matter. Usually a handful — skip the obvious ones (node_modules, generated). For unfamiliar dependencies, DeepWiki over guessing.
  5. Learn the conventions from the code, not the docs. Casing at the wire layer, how errors propagate, how config/env is read, test layout and style, the logging pattern. Cross-check against AGENTS.md — note every deviation.
  6. Hunt the landmines. Migrations in flight, // don't touch comments, code that looks wrong but has a reason, known-fragile areas, .out-of-scope/ if it exists.
  7. Build the glossary. The domain terms the code uses — pull the real ones, define them, list the synonyms to avoid.

Output — CONTEXT.md

Fill the template's sections: Overview, Language (glossary), Stack, Where things live, Deviations from AGENTS.md, Landmines, How to run it. Mark genuine unknowns as TBD rather than guessing.

For a deep glossary pass, hand off to Matt's domain-modeling (.agents/external-skills.md).

Anti-patterns

  • ❌ Reading files at random instead of tracing one flow.
  • ❌ Documenting the framework's structure instead of this project's.
  • ❌ Inventing domain terms the code doesn't use.
  • ❌ Skipping the landmines section — it's the highest-value part for the next session.

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.