agentleFS
kuhlman-labskuhlman-labs/fishhawk/.agents/skills/record-adr/SKILL.md

record-adr

Skill9 starsChanged 5 days agoApache-2.0View on GitHub

Record a ratified Fishhawk ADR and update its status, relationships and index. Use for accepted, amended or superseded decisions.

The file

We split this skill into the rules it gives an agent

9 rules. About 0 are common, 4 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    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. Distinctive:

    no unknown or duplicate keys

    line 45
  2. Very specific:

    accepted: only when a Decision-headed section states acceptance (Recorded <date>, Accepted, Approved, Decided, Adopt option X).

    line 50
  3. Very specific:

    superseded / rejected: only when a source says so.

    line 52
  4. Very specific:

    add ADR-X to the new record's supersedes

    line 69
  5. Very specific:

    add the new id to ADR-X's superseded_by

    line 70
  6. Distinctive:

    Add the row under "Records", matching the existing rows:

    line 84
  7. Very specific:

    If the status is unknown, also add a bullet under "Status unknown — needs captain confirmation" that quotes the source verbatim.

    line 88
  8. Distinctive:

    Timing: commit in the same change that records the ratification, or the one right after.

    line 93
  9. Distinctive:

    Tracker: if the ADR was just resolved, also edit the issue's Decision section and close it (Git flow step 7).

    line 94

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

Record an ADR

The format contract is docs/adr/README.md; read it before writing. The record transcribes and never corrects: the body below the H1 is the tracker issue body byte for byte. The only normalisations are CRLF → LF and exactly one trailing newline.

1. Fetch the source

gh issue view <N> --json number,title,body,url
  • Number: the ADR number comes from the title ([ADR-NNN] …).
  • File name: docs/adr/NNN-<kebab-slug>.md, with a zero-padded 3-digit prefix.

2. Write the record

---
id: ADR-NNN
title: "<issue title without the [ADR-NNN] prefix>"
status: <accepted|proposed|rejected|superseded|unknown>
date: YYYY-MM-DD
issue: https://github.com/kuhlman-labs/fishhawk/issues/<N>
supersedes: []
superseded_by: []
applies_to: []
---

# ADR-NNN: <title>

<issue body, verbatim>

Front-matter grammar

It is restricted:

  • one key: value per line
  • strings are JSON double-quoted, or a bare token
  • list keys are JSON arrays, always present ([] when empty)
  • no unknown or duplicate keys
  • date is optional

status: fail-closed inference

  • accepted: only when a Decision-headed section states acceptance (Recorded <date>, Accepted, Approved, Decided, Adopt option X).
  • unknown: a placeholder (_To be recorded._) or a design with no acceptance statement. Never guess upward. List unknowns for the user to confirm.
  • superseded / rejected: only when a source says so.

date

The date the Decision section states. Omit it if none is stated; it is not the implementation date.

applies_to

  • Default: [], unless the Decision or Consequences section names a repo path as the decision's subject. Citations and "see also" don't count.
  • Wildcards: a <placeholder> segment becomes *; a directory gets a trailing **.
  • Check: the gate verifies that each glob's literal stem appears in the body as a bounded path token.
  • When in doubt: [].

Supersession

Supersession is reciprocal. If the new ADR states it supersedes ADR-X:

  • add ADR-X to the new record's supersedes
  • add the new id to ADR-X's superseded_by
  • set ADR-X's status: superseded if the source says so

Both records must exist.

3. Index and table

scripts/check-adr --write-index      # regenerates docs/adr/index.json; never hand-edit it
scripts/check-adr                    # the gate; must pass

In docs/adr/README.md:

  • Add the row under "Records", matching the existing rows:
    | [ADR-NNN](NNN-slug.md) | <title> | `<status>` | [#N](<issue url>) |
  • If the status is unknown, also add a bullet under "Status unknown — needs captain confirmation" that quotes the source verbatim.

4. Gate and ship

  • Gate: scripts/check-adr also runs inside scripts/test verify.
  • Timing: commit in the same change that records the ratification, or the one right after. ADR-081 onward are added one at a time under the upkeep rule.
  • Tracker: if the ADR was just resolved, also edit the issue's Decision section and close it (Git flow step 7).

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.