agentleFS
pjlangleypjlangley/ff/.claude/skills/new-adr/SKILL.md

new-adr

Skill4 starsChanged 54 days agoUnlicenseView on GitHub

Create a new MADR-style architectural decision record in fragments/adrs/. Use when the user asks to draft, write, add, record, or create a new ADR / decision record / architectural decision. Computes the next zero-padded NNN, writes the file with the canonical structure, and appends a row to the README index table.

12 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use new-spec and release.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • eugenelimSkill

    new-spec

    Use this skill when the user wants to start a new feature with a spec, or wants to write a spec for something they're about to build. Triggers on "new spec", "write a spec for X", "let's spec this out", "start a feature for…". Spec-driven development; the spec drives implementation. Do NOT use for cross-cutting proposals (use `new-rfc`) or recording decisions (use `new-adr`).

    Also in 5 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 12 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

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

    Create a new architectural decision record in fragments/adrs/ and update the README index in one step.

    line 8
  2. Distinctive:

    Use the bold metadata line under the title (this repo's house style), not YAML frontmatter.

    line 76

“Common” is measured: kept by at least 6 in 10 of the 12 edited versions of this file we could read. “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

new-adr

Create a new architectural decision record in fragments/adrs/ and update the README index in one step.

When to use

Invoke when the user asks to create / draft / write / record an architectural decision. If the decision is already described in the conversation, draft from that context. Otherwise ask one consolidated question for: title, the chosen option, and a brief context — then proceed.

Procedure

  1. Compute the next number. List fragments/adrs/, find the highest existing NNN_*.md, add one, zero-pad to three digits. Numbers are never reused — even if a previous ADR was rejected or deleted, do not fill its slot.
  2. Derive the filename. NNN_title_with_underscores.md — snake_case, ASCII only, drop punctuation.
  3. Default the metadata. Status: Accepted and Date: = today's actual date (YYYY-MM-DD) — the date the record is accepted — unless the user says otherwise. Other valid statuses: Proposed, Rejected, Deprecated, Superseded by [NNN](NNN_title.md).
  4. Write the file at fragments/adrs/NNN_title_with_underscores.md using the canonical structure below. Include ### Consequences and ## More Information unless the user explicitly asks to omit them — both are optional but usually present.
  5. Update the README index. Append a new row to the | ADR | Date Accepted | table under ## Decision records in the repo-root README.md (i.e. ./README.md), linking to the new file. The index carries only the link and the accepted date — it has no status column, so a record's status (including supersession) lives in the record itself.
  6. Format. Run deno fmt fragments/adrs/<new-file>.md ./README.md.
  7. Report back with the new file path and a one-line note that the README index was updated.

Canonical ADR structure

Produce a file matching this shape (the leading # is the title, not a section break):

# {Short title — the solved problem and chosen solution}

**Status:** {Accepted | Proposed | Rejected | Deprecated | Superseded by [NNN](NNN_title.md)} | **Date:** {YYYY-MM-DD}

## Context and Problem Statement

{Two or three sentences. Make the scope of the decision explicit — point at the components/connectors involved.
Articulating it as a question is fine.}

## Considered Options

- {option 1}
- {option 2}
- ...

## Decision Outcome

Chosen option: "{...}", because {justification — the decisive criterion or the force it resolves}.

### Consequences

- Good, because {positive consequence}
- Bad, because {negative consequence}
- ...

## More Information

{Optional. Links to relevant code/docs, follow-up actions, or a Mermaid diagram. House style for diagrams uses
`config: { look: handDrawn }` to match the README. Diagrams may also sit inline above wherever they aid understanding.}

Conventions to honour

  • ADRs are immutable once accepted — never edit a past ADR's substance. To change a decision, write a new ADR with Status: Accepted whose body explains the change, and update the older ADR's status line to Superseded by [NNN](NNN_title.md). Status updates and typo fixes are the only acceptable edits.
  • Numbering is zero-padded and never reused.
  • Filenames and directory names are snake_case (project-wide convention).
  • Use the bold metadata line under the title (this repo's house style), not YAML frontmatter.

Out of scope

  • Auto-rewriting a superseded ADR's status. If the new ADR supersedes an older one, mention the older ADR's number in your report so the user can update it manually.

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.