adr
Write or update an Architecture Decision Record in docs/adr/ for OpenDataSuite. Use when an issue's acceptance criteria require an ADR, or when adding a crate, plugin contract, persisted format, CLI p
SKILL.mdskills/adr/SKILL.md
GitHubWrite an ADR
- List
docs/adr/and pick the next numberNNNN(4 digits, zero-padded). ADR-0000 is the template. - Copy
docs/adr/0000-template.mdtodocs/adr/NNNN-<kebab-title>.md. - Fill every section. Requirements:
- Context cites the driving issue(s) (
#N) and relevant AGENTS.md rules. - Options considered: at least two real alternatives, each with pros/cons.
- Decision is one clear statement; Consequences lists what becomes easier, harder, and what follow-up issues are needed.
- For module/crate decisions include a dependency diagram (Mermaid
graph LR). - For dependency decisions include licence, maintenance status, and an exit strategy.
- Context cites the driving issue(s) (
- Status starts as
Proposed; it becomesAcceptedwhen merged. Never edit the decision of an accepted ADR — supersede it with a new one and set the old one's status toSuperseded by ADR-NNNN. - Add the ADR to the index table in
docs/adr/README.md. - If the decision changes the roadmap or crate layout, update
docs/ROADMAP.mdand AGENTS.md in the same PR.