agentleFS
kuhlman-labskuhlman-labs/fishhawk/.agents/skills/spec-change/SKILL.md

spec-change

Skill9 starsChanged 5 days agoApache-2.0View on GitHub

Change a Fishhawk workflow/plan schema or REST API contract, including embedded mirrors, generated references and version advertising.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 1

    1. yisean/claude-spec-skills★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository11 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 0 are distinctive, and 5 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.

  • 5

    Very specific

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

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

    Treat fishhawk validate (without the flag) as the authority.

    line 28
  2. Very specific:

    add it to the plan validator's recognized set (backend/internal/plan/)

    line 30
  3. Very specific:

    Add docs/spec/workflow-vN.schema.json, then run scripts/sync-schemas.

    line 35
  4. Very specific:

    Add EmbeddedSchemaHashVN() plus the workflow-vN entry in the /healthz schemas map (backend/internal/server/handlers.go).

    line 37
  5. Very specific:

    Run the verify-gate skill.

    line 50

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

Change a schema or API contract

Canonical sources live in docs/spec/ (schemas + reference docs) and docs/api/ (OpenAPI). Each is mirrored or rendered into several places, and CI fails on every one that's missed.

1. Classify the change first

  • Additive. A new optional field within the current major. Proceed.
  • Breaking. A new required field, a removed field, or a narrowed type, in an existing major. Don't do it in place: bump the major (workflow-vN+1, standard_v2).
    • For a field meant to become required later, add it optional and annotate it with "x-intended-required": true.
    • Declare the soak window in the PR body under ## Notes.

State the classification to the user before editing.

2. Edit and propagate (workflow / plan schemas)

  1. Edit the canonical docs/spec/<name>.schema.json and its reference doc docs/spec/<name>.md. For the workflow spec, docs/spec/workflow-v2.md is the complete reference for the live major.
  2. scripts/sync-schemas mirrors the change into backend/internal/spec/schemas/ and cli/internal/spec/schemas/ (and the plan mirrors). Commit the mirrors with it.
  3. scripts/gen-site-reference re-renders the generated regions of site/src/content/docs/reference/*.md. Edit only outside the BEGIN/END GENERATED markers.
  4. Validate the examples:
    • check-jsonschema --schemafile docs/spec/<schema> <example.yaml>
    • A workflow-v2 doc using defaults/extends must go through the product validator: fishhawk validate --emit-resolved <yaml> | check-jsonschema --schemafile docs/spec/workflow-v2.schema.json --default-filetype yaml - Treat fishhawk validate (without the flag) as the authority.
  5. Version advertising. For a new version string:
    • add it to the plan validator's recognized set (backend/internal/plan/)
    • inspect existing schema-advertising surfaces; backend /healthz advertises workflow schema hashes (see the new-major steps). Do not introduce a speculative runner endpoint as part of this change.

A NEW workflow major (also)

  • Add docs/spec/workflow-vN.schema.json, then run scripts/sync-schemas. The workflow-v* glob routes it; no script edit is needed.
  • Append {Major: N, Path: …} to embeddedSchemas in both backend/internal/spec/parse.go and cli/internal/spec/spec.go. Without it, the validator fails closed on the new major.
  • Add EmbeddedSchemaHashVN() plus the workflow-vN entry in the /healthz schemas map (backend/internal/server/handlers.go).
  • Register the mirror set as a surface-sweep pattern in backend/internal/server/surface_sweep.go.
  • Bumping .fishhawk/workflows.yaml's version: major makes scripts/dev up/reload print the schema-major MCP banner. Expect it.

3. REST API changes

  • Source of truth: docs/api/v0.openapi.yaml. Update the human companion docs/api/v0.md with it.
  • Lint with the pinned version: npx -y @redocly/cli@2.31.5 lint --config docs/api/redocly.yaml docs/api/v0.openapi.yaml
  • Re-run scripts/gen-site-reference; reference/api.md is generated from it.
  • A tightened auth check also needs the PR-body Auth change checklist (fishhawkd token migrate dry-run inventory). See change checklists.

4. Gate

Run the verify-gate skill. Its schema-sync step catches a missed mirror, and the site-reference drift test catches a missed regeneration.

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.