47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# ADR-NNNN: Title
|
|
|
|
**Status:** Proposed | Accepted | Superseded | Deprecated
|
|
**Date:** YYYY-MM-DD
|
|
**Deciders:** (@username, @username)
|
|
**Supersedes:** (link to an earlier ADR, if applicable)
|
|
**Superseded by:** (link, if applicable)
|
|
|
|
## Context
|
|
|
|
What forces are at play? What problem are we solving? Include both the
|
|
technical context (what systems are involved, what constraints apply) and
|
|
the product context (what user need, what Morphit principle this touches
|
|
— non-custody, uncensorability, grandma-friendliness, PFS, etc.).
|
|
|
|
## Decision
|
|
|
|
What did we decide, phrased as an imperative. Keep it tight: one to three
|
|
sentences. Details go in "Consequences."
|
|
|
|
## Alternatives considered
|
|
|
|
At least two alternatives and why we rejected each. Decisions made without
|
|
real alternatives are not decisions; they're defaults, and they belong in
|
|
code comments, not ADRs.
|
|
|
|
- **Alternative A** — description. Rejected because: reason.
|
|
- **Alternative B** — description. Rejected because: reason.
|
|
|
|
## Consequences
|
|
|
|
### Positive
|
|
|
|
- What gets easier, safer, or more consistent?
|
|
|
|
### Negative
|
|
|
|
- What gets harder or slower?
|
|
- What new responsibilities does this impose?
|
|
|
|
### Follow-up work
|
|
|
|
- Specific tasks this decision implies (with links to issues where applicable).
|
|
|
|
## References
|
|
|
|
- Any specs, papers, RFCs, or prior art that informed the decision.
|