agentleFS
OvichOvich/charrette/skills/guides/guide-deepen-module/SKILL.md

guide-deepen-module

Skill14 starsChanged 5 days agoMITView on GitHub

Use when code is written or changed that adds a module or changes a module's public interface, in any tier. Produces an interface shaped before the code behind it, and the bar it must meet at merge. Not for designing the interface with the person (deepen-module) and not for code that leaves every interface as it was.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    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:

    Before the code behind it, write the interface: the one entry point a caller uses, as signatures.

    line 12
  2. Distinctive:

    Check each caller: it calls the entry, never reaches past it.

    line 14
  3. Distinctive:

    No caller was changed to work around the module.

    line 21

≈ “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

Guide: deep modules

Applies to any new module, and any change to what an existing module exposes: its exports, its signatures, what its callers must know.

Shaping step

  1. Before the code behind it, write the interface: the one entry point a caller uses, as signatures.
  2. Name what stays inside: every type, helper and state a caller does not need.
  3. Check each caller: it calls the entry, never reaches past it.
  4. The interface is contested, or callers already know too much: stop and run the deepen-module skill.

Ok at merge

  • Callers import the entry point alone; nothing behind it is imported from outside.
  • The interface is smaller than what it hides.
  • No caller was changed to work around the module.

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.