github.com/gemaraproj/gemara@v0.23.0

docs/adrs/index.md raw

 1---
 2layout: page
 3---
 4
 5# Architecture Decision Records
 6
 7Architecture Decision Records document important architectural decisions made in the project. 
 8
 9They capture:
10
11- The context that led to the decision
12- The decision itself
13- The consequences (positive, negative, and neutral)
14- Alternatives that were considered
15
16## Format
17
18ADRs follow the format described at [adr.github.io](https://adr.github.io/), with the following structure:
19
201. **Status** - Proposed, Accepted, Deprecated, or Superseded
212. **Context** - The situation and problem that led to this decision
223. **Decision** - The architectural decision and its rationale
234. **Consequences** - Positive, negative, and neutral outcomes
245. **Alternatives Considered** - Other options that were evaluated
25
26## When to Create an ADR
27
28Create an ADR when:
29
30- Making a significant architectural decision that affects the public API
31- Choosing between multiple viable approaches
32- The decision will impact future development or maintenance
33- The decision needs to be communicated to stakeholders
34
35Don't create an ADR for:
36
37- Routine implementation details
38- Temporary workarounds
39- Decisions that are clearly the only viable option