DevContainer User
1.9 KiB
1.9 KiB
Architecture Decision Records (ADRs)
What is an ADR?
An Architecture Decision Record (ADR) captures an important architectural decision made along with its context and consequences. ADRs are immutable once accepted — if a decision is reversed, a new ADR is created that supersedes the original.
Format
This project uses the Nygard-style ADR format:
- Title: Short noun phrase describing the decision
- Status: Proposed, Accepted, Deprecated, or Superseded
- Context: Forces at play, including technical, political, and project-specific
- Decision: The change being proposed or enacted
- Consequences: What becomes easier or harder as a result
Index
| ADR | Title | Status | Date |
|---|---|---|---|
| 001 | React Context for Centralized Rook-Ceph State | Accepted | 2026-03-05 |
| 002 | extractJsonData() Pattern for KubeObject Unwrapping | Accepted | 2026-03-05 |
| 003 | Strictly CommonComponents Only (No Direct MUI) | Accepted | 2026-03-05 |
| 004 | Read-Only Plugin with Cluster-Wide RBAC Scope | Accepted | 2026-03-05 |
Creating New ADRs
- Copy an existing ADR as a template.
- Assign the next sequential number (e.g.,
005). - Fill in all sections: Context, Decision, Consequences, Alternatives Considered.
- Set the status to Proposed and submit a PR for review.
- Once merged, update the status to Accepted and add the entry to the index table above.
Use the filename pattern NNN-short-slug.md (e.g., 005-new-decision.md).