agentleFS
rpraharajrpraharaj/ai-engineer/skills/explain-code/SKILL.md

explain-code

Skill1 starsChanged 15 days agoMITView on GitHub

Teach a feature, path, or subsystem from the code that exists — entry points, data flow, and what to change. Use when the user asks how X works, explain this, walk me through, or is onboarding onto a feature. Do not implement. Do not invent architecture the tree does not have.

48 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use copy-editing, pricing-strategy and 6 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.
  • silvainfmSkill

    copy-editing

    When the user wants to edit, review, or improve existing marketing copy. Also use when the user mentions 'edit this copy,' 'review my copy,' 'copy feedback,' 'proofread,' 'polish this,' 'make this better,' or 'copy sweep.' This skill provides a systematic approach to editing marketing copy through multiple focused passes.

    Also in 3 projects that use this

  • silvainfmSkill

    pricing-strategy

    When the user wants help with pricing decisions, packaging, or monetization strategy. Also use when the user mentions 'pricing,' 'pricing tiers,' 'freemium,' 'free trial,' 'packaging,' 'price increase,' 'value metric,' 'Van Westendorp,' 'willingness to pay,' or 'monetization.' This skill covers pricing research, tier structure, and packaging strategy.

    Also in 3 projects that use this

  • SentrySkill

    marketing-psychology

    When the user wants to apply psychological principles, mental models, or behavioral science to marketing. Also use when the user mentions 'psychology,' 'mental models,' 'cognitive bias,' 'persuasion,' 'behavioral science,' 'why people buy,' 'decision-making,' or 'consumer behavior.' This skill provides 70+ mental models organized for marketing application.

    Also in 3 projects that use this

  • GitHubSkill

    refactor

    Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.

    Also in 4 projects that use this

  • OpenAISkill

    writing-plans

    Use when you have a spec or requirements for a multi-step task, before touching code

    Also in 4 projects that use this

  • GoogleSkill

    grill-me

    A relentless interview to sharpen a plan or design.

    Also in 7 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 41 edited versions we read keep these.

  • 4

    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 AGENTS.md if present (glossary first).

    line 14
  2. Distinctive:

    Use the symbol, file, route, or feature the user named.

    line 18
  3. Distinctive:

    Stop when you can say where it starts, what it does, and where an edit would go.

    line 29
  4. Distinctive:

    Use names from this repo. If a term is in the AGENTS.md glossary, use that meaning.

    line 60

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

Explain code

Teach one feature or path so the next edit is aimed. Do not implement. Do not map the whole repository (explore-codebase does that). Do not invent types, services, or diagrams the code does not support.

Read AGENTS.md if present (glossary first).

Target

Use the symbol, file, route, or feature the user named. If they did not name one, pick the hottest match from their question and say so. If you still cannot tell, ask one blocking question and stop.

Read

Skim only what the path needs:

  1. The entry (route, CLI command, job, screen, exported function)
  2. The next 1–2 layers it calls
  3. The data it reads or writes (types, tables, events)
  4. Tests nearest the path

Stop when you can say where it starts, what it does, and where an edit would go. Do not dump the tree.

Write this tour

# How <target> works

## Starts at
<path or symbol> — <one line>

## What it does
<three to eight sentences, in this repo's terms>

## Data
- In:
- Out:
- Stored / sent:

## Call chain
1. `symbol` (`path`) — …
2. …

## Tests
<files that pin this path, or none found>

## If you change it
- Touch:
- Do not touch:
- Nearby trap:

Use names from this repo. If a term is in the AGENTS.md glossary, use that meaning. Do not add glossary entries here.

Done

The tour. Next is usually shape-work or implement-change if they want a change, not a refactor you were not asked for.

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.