agentleFS
rpraharajrpraharaj/ai-sdlc/skills/explore-codebase/SKILL.md

explore-codebase

Skill0 starsChanged 15 days agoMITView on GitHub

Map an unfamiliar repository — stack, install/run/test/lint commands, layout, entry points, and conventions. Report a map and proposed AGENTS.md updates from evidence without writing files. Use when starting in a new repo, onboarding, or before changing code you have not read. Do not invent commands.

13 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use debug-issue, review-changes 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.
  • NVIDIASkill

    debug-issue

    Use when the user asks to debug, investigate, or fix a GitHub issue or supplies a repository bug report.

    Also in 5 projects that use this

  • DockerSkill

    review-changes

    Review uncommitted or recently committed documentation changes for correctness, coherence, and style compliance. Use before creating a PR to catch issues. "review my changes", "review the diff", "check the fix before submitting", "does this look right".

    Also in 4 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

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

    Read root AGENTS.md if present.

    line 38

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

Explore codebase

A stranger can run, test, and change this repo without guessing. Do not implement product features. Do not invent commands you did not see in a file or run successfully.

Is this the right skill?

SignalDo this instead
How one feature worksexplain-code
Empty tree, start an appstart-project
Shape a change you already understandshape-work

Required inputs

  • A workspace you can list and read
  • Git root if this is a repo (git rev-parse --show-toplevel)

Human decisions (do not invent)

  • None for the map. Do not invent glossary jargon.

Procedure

  1. Read root AGENTS.md if present. Record Root.
  2. Detect stack only from files that exist (manifests, lockfiles, CI). See references/stack-evidence.md.
  3. Resolve Install / Run / Test / Lint / Typecheck / Build from manifests or CI. Prefer the CI command. Else (unknown). Never invent npm test.
  4. Stay read-only: use read/search commands only. Record discovered checks as not run; hand execution to verifier and dependency installation to implementer. Do not run tests, install dependencies, or start servers in an explore session.
  5. Map layout from README + shallow listing (not node_modules / vendor / dist / .git).
  6. Open references/agents-template.md and report proposed managed blocks. A planner session may persist them: replace only matching managed blocks; if absent, append the managed repo section without overwriting existing commands or program-context pointers. Flag conflicting commands for resolution. Glossary facts live only in context/glossary.md; propose additions there, or report terms in the reply if that file does not exist.

Output

  • Path: reply; optional planner handoff for root AGENTS.md managed sections
  • Template: references/agents-template.md

Quality bar

  • Every command is from a file you opened or a command you ran
  • Unknowns are (unknown)
  • No invented glossary terms
  • No secrets
  • No files edited or executable checks run by the explore profile

Done

  1. Root and languages
  2. Commands you ran and pass/fail
  3. Layout + do-not-edit
  4. Proposed AGENTS.md blocks and any planner / verifier / implementer handoffs
  5. Next: shape-work or debug — not a drive-by refactor

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.