agentleFS
shuvamkshuvamk/openbench/.claude/skills/ir-schema-guard/SKILL.md

ir-schema-guard

Skill2 starsChanged 5 months agoApache-2.0View on GitHub

Validates any interchange-format (IR) change against .context/interchange-format.md and all engine adapters. Use BEFORE merging any change to packages/ir-schema or the IR doc. Flags breaking changes and forces version bumps.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Round-trips still hold: All adapter contract tests (import(export(doc)) == doc) green.

    line 22
  2. Very specific:

    Docs: Update .context/interchange-format.md (schemas + changelog note) and append an ADR to .context/decisions.md if the change resolves an …

    line 25

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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

ir-schema-guard

The IR is the constitution of this repo. Any change is a breaking-change candidate.

Checklist (run every item; all must pass)

  1. Spec ↔ code sync. .context/interchange-format.md and packages/ir-schema/src must describe the same shapes. Run npm run test -w packages/ir-schema — the spec-sync tests parse the documented examples with the live schemas.
  2. Classify the change.
    • Additive (new optional field, new enum value consumed nowhere yet): patch bump.
    • Breaking (rename, remove, retype, new REQUIRED field, semantics change): pre-1.0 → minor bump of IR_VERSION; post-1.0 → major.
  3. Blast radius. Grep every adapter (packages/mcp-*, packages/netlist-compiler, apps/web) for the touched field/kind. Every consumer updates in the SAME PR — the IR never merges ahead of its consumers.
  4. Round-trips still hold. All adapter contract tests (import(export(doc)) == doc) green. Newly-lossy fields → documented in .context/engine-status.md in the same PR.
  5. Docs. Update .context/interchange-format.md (schemas + changelog note) and append an ADR to .context/decisions.md if the change resolves an open item.
  6. Migration. Breaking change → migrate(doc, fromVersion) support in packages/ir-schema so stored documents keep loading, with a test per migration.

Hard stops

  • Deleting a document kind, the irVersion field, or provenance → this is status:needs-design territory. Do not proceed autonomously.

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.