agentleFS
Sign inStart free
colasamacolasama/MahoShojo-Generator/.agents/skills/api-contract-change/SKILL.md

api-contract-change

Skill167 starsChanged 27 days agoApache-2.0View on GitHub

Use when changing API/DTO/schema/wire-format contracts, SSE/event payloads, shared protocol packages, or producer/consumer mappings across MahoShojo-Generator runtimes. Do not use for implementation-only changes that preserve the existing contract.

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:

    Add regression coverage at the boundary that previously allowed drift, including replay/reconnect paths when the protocol supports them.

    line 15
  2. Distinctive:

    Run targeted contract/runtime tests first.

    line 16
  3. Distinctive:

    Ask only when the desired breaking/compatibility policy is genuinely unresolved by current accepted docs or when production …

    line 20

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

API Contract Change

Workflow

  1. Locate the canonical schema/contract and applicable accepted ADR/spec from the relevant docs topic.
  2. Enumerate every producer, consumer, mapper/adapter, persistence/replay path, public projection and compatibility test before editing.
  3. Separate internal telemetry/server fields from public client contracts; do not leak server-only authority or secrets through a convenience projection.
  4. Decide compatibility behavior explicitly: additive/backward-compatible, versioned, migration required, or intentionally breaking.
  5. Modify the canonical contract first, then synchronize producers/consumers and regenerate derived artifacts using existing repo tools.
  6. Add regression coverage at the boundary that previously allowed drift, including replay/reconnect paths when the protocol supports them.
  7. Run targeted contract/runtime tests first; expand to workspace/global verification only when shared boundaries changed.

Stop / ask

Ask only when the desired breaking/compatibility policy is genuinely unresolved by current accepted docs or when production migration/cutover authorization is required.

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.

Check your setup, free