adrkit-note

Files (1)

• SKILL.md

SKILL.md (first lines)

# ADR Kit Note

The note buffer preserves important context that may otherwise disappear while work continues. Capture only potentially useful missing context; routine upgrade events and visual tweaks need no note. Before shaping a note, use the recording judgment in propose or record. A note may be discarded when it has no independent value; it is not a promise to create an ADR.

Run `adrkit note "<one line>"`; it appends a timestamped line to `adr/notes.md`, creating the file on first use. The buffer is a plain file outside the lifecycle — no front matter, no template, no number — and `adrkit validate` ignores it: notes are debt, not authority, and never a fifth lifecycle folder. Shape one when the moment allows — `adrkit propose` and `adrkit grill` read the buffer as candidate material, and `adrkit record` takes an already-shipped choice straight from it — and delete a line that shaped nothing. `adrkit list` and `adrkit instructions` count the unshaped lines so the debt stays visible.


When a source is already available, retain a PR/discussion link, commit, or attributed statement in the same line; capture must stay cheap and a source is optional. Distinguish a settled choice from a candidate needing confirmation, for example `Candidate: use SQLite; rationale unknown; source: PR #42`. Do not create alternatives or infer who decided from a transcript author, Git identity, or approval. Before shaping a note, inspect its source and resolve unknowns; a note proves neither a choice nor delivery.

From luochang212/adr-kit, MIT.

More from luochang212/adr-kit