agentleFS
ChristopherAlphonseChristopherAlphonse/calphonse-skills/whats-going-on/SKILL.md

whats-going-on

Skill1 starsChanged 11 days agoMITView on GitHub

One-pass codebase intelligence sweep. Use when onboarding to a repo or asking "what's going on here?" Produces a concise map of core use cases, lifecycle, architecture, and where to start reading.

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 5 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create a concise onboarding map in one pass.

    line 8
  2. Distinctive:

    Do not modify source code.

    line 12
  3. Distinctive:

    Prefer evidence over guesses.

    line 13
  4. Very specific:

    Read the smallest set of files that explains the system: README, package/build config, routes/entrypoints, tests, core modules, .planning/* …

    line 15
  5. Very specific:

    Synthesize directly: Write one artifact to .planning/system/whats-going-on.md.

    line 22
  6. Very specific:

    Create .planning/system/ if needed.

    line 24
  7. Distinctive:

    Only write these when the repo is complex enough that separate docs will stay useful:

    line 60
  8. Distinctive:

    If the user asks to be walked through the codebase or a subsystem instead of handed a document, follow references/teach.md.

    line 68

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

What's Going On

Create a concise onboarding map in one pass. Default to reading files yourself; use sub-agents only if the repo is large enough that parallel exploration clearly saves time.

Guardrails

  • Do not modify source code.
  • Prefer evidence over guesses. Cite files for important claims or label assumptions.
  • Focus on core use cases, lifecycle, architecture, and navigation. Skip roadmap, refactor advice, and peripheral features.
  • Read the smallest set of files that explains the system: README, package/build config, routes/entrypoints, tests, core modules, .planning/* if present.

One-Pass Workflow

  1. Orient: Identify repo type, run/build/test commands, main entrypoints, and existing docs.
  2. Trace core flows: Find 3-5 primary user or system flows from entrypoint to response, job completion, persistence, or external call.
  3. Map architecture: Identify 5-10 major components only. Exclude thin wrappers, utilities, and config-only files.
  4. Synthesize directly: Write one artifact to .planning/system/whats-going-on.md.

Create .planning/system/ if needed.

Output Shape

# What's Going On - <repo name>

## Core Use Cases

- <use case>: <what it does>
  Evidence: <key files>

## Lifecycle

- <flow>: <entry> -> <validation/business logic> -> <persistence/external call> -> <result>

## Architecture

| Component | Responsibility | Key Files |
| --------- | -------------- | --------- |

## New Engineer Navigation

- Start here: <file/doc>
- Core logic: <files>
- Data enters/exits: <files/routes/jobs>
- Integrations: <services/protocols>
- Run first: <command>

## Assumptions And Unknowns

- <only if needed>

Optional Sidecar Files

Only write these when the repo is complex enough that separate docs will stay useful:

  • .planning/system/use_cases.md
  • .planning/system/lifecycle.md
  • .planning/system/architecture.md

Teaching The Map

If the user asks to be walked through the codebase or a subsystem instead of handed a document, follow references/teach.md.

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.