create-adr

Original🇺🇸 English
Translated

Create a new Architecture Decision Record in doc/adr/

5installs
Added on

NPX Install

npx skill4agent add smartworkx/dev-context create-adr
Create a new Architecture Decision Record (ADR) in
doc/adr/
using the Nygard format.

Steps

  1. If the user did not provide a decision title as an argument, ask them for one
  2. Convert the title to kebab-case for the filename
  3. Use today's date (YYYY-MM-DD) as prefix:
    doc/adr/YYYY-MM-DD-kebab-case-title.md
  4. Create the file with this template:
markdown
# [Title]

**Status:** proposed

## Context

[What is the issue? What forces are at play? What is the background?]

## Decision

[What is the change that we're proposing and/or doing?]

## Consequences

[What becomes easier or more difficult to do because of this change?
Include positive, negative, and neutral consequences.]
  1. Tell the user the file was created and its path
  2. Remind them: "ADRs are immutable once accepted — to change a decision, supersede it with a new ADR."