adr
/adr
Zapisuje, wyszukuje i uwzględnia rekordy decyzji architektonicznych przez CLI adr przed zmianą architektury lub interfejsu.
- Autor
- maximiliancw ↗
- Repozytorium
- adrinaline ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 12.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 2
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 12.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Zapisuje, wyszukuje i uwzględnia rekordy decyzji architektonicznych przez CLI adr przed zmianą architektury lub interfejsu.
Oryginalny opis (EN)
Record, find and respect Architecture Decision Records (ADR, decision record, docs/adr) with the `adr` CLI. Use before changing architecture, adding a dependency, changing a public interface, data format or security control, and whenever a task touches files governed by an ADR.
Jak działa
- At the start of a task
- Statuses
- When to write an ADR
- Writing one
- Accepting a proposed ADR
- Changing a decision
- Reviewing a decision
- Citing decisions in commits
- Before finishing
- If check fails
Podgląd SKILL.md
---
name: adr
description: Record, find and respect Architecture Decision Records (ADR, decision record, docs/adr) with the `adr` CLI. Use before changing architecture, adding a dependency, changing a public interface, data format or security control, and whenever a task touches files governed by an ADR.
compatibility: requires the adr CLI and git
license: MIT
metadata:
version: "{version}"
---
# Architecture Decision Records with `adr`
ADRs are Markdown files in the repository (usually `docs/adr/NNNN-slug.md`) with YAML frontmatter. `adr` manages them. Every command accepts `--json`; prefer it when parsing. An installed copy of this skill goes stale after you upgrade adr: reinstall it with `adr skill --install DIR` (or `npx skills update`, or update the plugin, if you installed it that way). Details: `references/frontmatter.md`.
## At the start of a task
1. Run `adr prime` to see the decisions in force. Its sections: decisions in force, a *Needs review* list when a decision is overdue or its code has churned, proposed ADRs, and short usage rules.
2. Before editing a file, run `adr for <path>` and follow the ADRs it lists. Use `adr show N` to read a whole decision.
3. If a command fails with `no-adr-dir` (exit 3), ask the user before running `adr init`; `adr init --agents` also adds the `adr prime` line to `AGENTS.md` and installs this skill.
Abbreviated `adr for --json` output:
```json
{"src/db/conn.py": [{"number": 7, "id": "0007", "title": "Use PostgreSQL", "status": "accepted", "path": "docs/adr/0007-use-postgresql.md", "scope": ["src/db/**"]}]}
```
## Statuses
`proposed`, `accepted`, `rejected`, `deprecated`, `superseded`. `adr new` makes `proposed`; `adr accept N` and `adr reject N` act on proposed; `adr deprecate N` acts on accepted; `adr new "…" --supersedes N` (or `adr supersede OLD --by NEW`) makes an accepted ADR `superseded`. `--supersedes` on a non-accepted ADR needs `--force`.
## When to write an ADR
Write one for decisions that are expensive to reverse: architecture, frameworks and dependencies, data formats and storage, public interfaces, security and compliance controls. Do not write one for routine implementation choices.
## Writing one
Set `--scope GLOB` (repeatable, repository-relative) so `adr for <path>` finds the ADR.
```bash
adr new "Use PostgreSQL for persistence" --tag storage --scope "src/db/**" --body-file - <<'EOF'
## Context and Problem Statement
…
## Considered Options
* PostgreSQL
* SQLite
## Decision Outcome
Chosen option: "PostgreSQL", because …
### Consequences
* Good, because …
* Bad, because …
EOF
```
New ADRs start as `proposed`. A human accepts them with `adr accept N`. Do not put `# Title` in the `--body-file` body (adr adds it). Avoid `--edit`: it opens an interactive editor. If you have a question tool, ask through it.
## Accepting a proposed ADR
When the human approves a plan, or you are about to commit a change, and it touches the scope of a proposed ADR (`adr for --all <path>` lists it; plain `adr for` shows only ADRs in force), ask first:
```text
This change relates to the following proposed ADRs:
- 0007 Use PostgreSQL (docs/adr/0007-use-postgresql.md)
Approve status change to accepted? [y/N]
```
N is the number in the filename that `adr new` prints; a fresh proposed ADR only shows up with `adr for --all`. On yes, run `adr accept N` and include the status change in the same commit. On anything else, leave it proposed.
## Changing a decision
Never rewrite the decision of an accepted ADR. Instead:
* Replace it: `adr new "…" --supersedes N`
* Change part of it: `adr new "…" --amends N`
* Relations: `supersedes`, `amends`, `depends-on`, `relates-to`. Add one later with `adr link SRC RELATION DST` (RELATION is `amends`, `depends-on` or `relates-to`), e.g. `adr link NEW depends-on N`.
## Reviewing a decision
`adr prime` and `adr check` report `review-overdue` (its `review-by` date has passed) and `stale-decision` (many commits touched its `scope` since it was written or last reviewed; `adr drift` shows the numbers). Read the ADR and the code in its scope, tell the human whether the decision and its `revisit-if` assumption still hold, and only on their confirmation run `adr review N --until YYYY-MM-DD`. Never record a review you did not do. When writing an ADR, `--review-by YYYY-MM-DD` sets the first review date.
## Citing decisions in commits
End the commit message with a trailer naming the ADRs the change follows: `ADR: N`, or `ADR: 3, 7` for several. A change to files an ADR governs that follows none of them gets `ADR-Exempt: reason` instead. `adr check --diff <base>` warns `uncited-change` for governed commits without either and lists exemptions as `exempt-change` notes; `adr trace N` lists the commits citing an ADR.
## Before finishing
Run `adr check` (`--fix` repairs mechanical findings). Fix every error it reports.
## If check fails
Exit codes: 1 `check` found problems, 2 usage error, 3 domain error (e.g. `not-found`, `invalid-transition`, `no-adr-dir`). Errors fail `check`; warnings fail it only with `--strict`; notes never do. With `--json`, `check` prints `{"ok": bool, "findings": [...]}` and other failures `{"error": {"code": "...", "message": "..."}}`.
Pliki w paczce (2)
- SKILL.md 5 KB
- references/frontmatter.md 4 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · maximiliancw/adrinaline | 100 | MIT |
| pJijesh/adr-skill | 100 | MIT |
| zazencodes/skills | 100 | MIT |
| vindotski/spotcraft | 100 | Apache-2.0 |
| me-cedric/Shipyard | 100 | MIT |
| musingfox/cc-plugins | 100 | MIT |
| joestump/claude-plugin-sdd | 100 | MIT |
| kaisa-kucherenko/claude-code-flow | 100 | MIT |
| nguyengiavu/ngvu-factory | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki c03f73acaf82 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100adr-writer
Generuje rekordy decyzji architektonicznych z kontekstem, uzasadnieniem, alternatywami i konsekwencjami w numerowanym formacie ze śledzeniem statusu. - 100030-architecture-adr-general
Prowadzi rozmowę i tworzy rekordy decyzji architektonicznych ADR dla projektu Java, z kontekstem i opcjami. - 100recording-architecture-decisions
Tworzy, aktualizuje, zastępuje i ocenia ADR oraz dziennik decyzji architektonicznych, w tym synchronizację bazową po zmianach architektury. - 100adr-tools
Tworzy i zarządza rekordami decyzji architektonicznych za pomocą CLI adr-tools Nat Pryce'a: dodawanie, zastępowanie i łączenie ADR oraz generowanie spisu treści. - 100architecture
Zarządza rekordami decyzji architektonicznych (ADR) i diagramami C4. - 90create-adr
Pisze nowy rekord decyzji architektonicznej w docs/adr, w formacie tego repozytorium, po pokazaniu pełnego szkicu.