Architecture Decision Records
Immutable record of Eigenoid's architectural and organizational decisions. Each ADR captures a significant decision, the context behind it, the alternatives considered, and its consequences.
Principles
- Immutable: once
Accepted, an ADR is never edited. If the decision changes, a new ADR is created that supersedes the previous one. - Sequential numbering: numbers are never reused, even for rejected ADRs.
- Written before or during the decision: these are not retroactive documentation; they capture the thinking at the time.
- Broad scope: decisions that affect more than one module, repo, or person. Local decisions belong in the code or in PRs.
Statuses
| Status | Meaning |
|---|---|
Proposed | Open proposal under discussion, not yet adopted. |
Accepted | Active decision. |
Rejected | Discarded proposal; kept to preserve the reasoning. |
Deprecated | No longer applies, but was not replaced by another decision. |
Superseded by ADR-NNNN | Replaced by a later ADR. |
Index
How to propose a new ADR
- Copy
template.mdasNNNN-short-title.mdwith the next available number. - Fill in the context, decision, and consequences.
- Open a PR with status
Proposedand request review. - Once accepted, update the status to
Accepted, add the entry to this index, and merge.