agentleFS
AdityaZxxxAdityaZxxx/skills/declared-breaks/SKILL.md

declared-breaks

Skill1 starsChanged 25 days agoMITView on GitHub

Treat any change to an existing public shape as a declared break. Preserve compatibility, migrate callers in the same change, or flag the break with its blast radius. Use when editing a signature, field, data shape, log or event format, or configuration that existing callers depend on; when replacing a representation; or when a refactor outgrows the shape it started from.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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:

    Preserve: Keep the old shape working while the new one exists: a default parameter, the old field alongside the new, dual-writing during a …

    line 13
  2. Distinctive:

    Migrate: Update every caller and delete the old shape in the same change.

    line 14

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

Declared breaks

A break to an existing shape is a legitimate engineering move. A silent break is a defect: code that compiled yesterday and betrays its callers today, with nothing in the record to warn them. The discipline is not avoiding breaks. It is making sure every break takes one of the three honest paths.

The three honest paths

  • Preserve. Keep the old shape working while the new one exists: a default parameter, the old field alongside the new, dual-writing during a transition. The default when callers are many, outside your reach, or unknown.
  • Migrate. Update every caller and delete the old shape in the same change. Honest only when every consumer is reachable in this repo and the tests now assert the new contract. A migration that leaves one caller behind is a silent break wearing a costume.
  • Declare. When callers exist outside your reach (another repo, an API consumer, a human reading a log), flag the break explicitly: what breaks, who it hits, and the blast radius. A one-way door (persisted data, wire formats, published interfaces) is a different statement than a two-way one. Say which.

Reporting is not declaring

Describing a change in a summary ("the audit log now carries structured entries") records a decision. It warns no one. A declaration names the danger: "this breaks readers of the old string log; they need X." If your writeup would read exactly the same on a change with no blast radius, it declares nothing.

The test

Before finishing a change, ask: did this diff change what any existing caller must know? Grep for who reads the shape, and remember that some callers cannot be grepped: persisted data is a caller, and so is a person with a saved export. If the answer is yes and the change was not preserved, migrated, or declared, the break is silent, and silent is the one outcome to avoid.

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.