From 21d1c58297d9add9ca3a941b276b384ba2a1a55f Mon Sep 17 00:00:00 2001 From: Andrew Block Date: Sun, 23 Aug 2026 22:47:31 -0500 Subject: [PATCH] docs: Added ADR template Signed-off-by: Andrew Block --- docs/adr/000-template.md | 79 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 docs/adr/000-template.md diff --git a/docs/adr/000-template.md b/docs/adr/000-template.md new file mode 100644 index 0000000..5920430 --- /dev/null +++ b/docs/adr/000-template.md @@ -0,0 +1,79 @@ +# ADR-XXX: Title Here + +**Status**: Proposed | Accepted | Deprecated | Superseded + +**Date**: YYYY-MM-DD + +**Authors**: Name(s) + +## Context + +What is the issue we're seeing that motivates this decision or change? + +Include: + +- Background information +- Problem statement +- Constraints +- Forces at play + +## Decision + +What is the change that we're proposing and/or doing? + +Be specific and clear about: + +- What we decided to do +- Why this approach over alternatives +- Key implementation details + +## Consequences + +What becomes easier or more difficult to do because of this change? + +### Positive + +- What benefits does this decision bring? +- What problems does it solve? +- What becomes easier? + +### Negative + +- What tradeoffs are we accepting? +- What becomes harder? +- What new problems might arise? + +### Neutral + +- What stays the same? +- What is unaffected? + +## Alternatives Considered + +What other options did we evaluate? + +For each alternative: + +- Brief description +- Why we didn't choose it +- What would have been different + +## Related Decisions + +- ADR-XXX: [Related decision] +- ADR-YYY: [Another related decision] + +## References + +- [Link to documentation] +- [Link to discussion] +- [Link to research] + +--- + +## Revision History + +| Date | Author | Change | +|------|--------|--------| +| YYYY-MM-DD | [Name] | Initial proposal | +| YYYY-MM-DD | [Name] | Accepted after review | \ No newline at end of file