|
| 1 | +# [short title of solved problem and solution] |
| 2 | + |
| 3 | +* Status: [proposed | rejected | accepted | deprecated | … | superseded by ADR-1234] |
| 4 | +* Authors: [list everyone who authored the decision] |
| 5 | +* Date: [YYYY-MM-DD when the decision was last updated] |
| 6 | +* Targeted modules: [which crate or module does this change target] |
| 7 | +* Associated tickets/PRs: [PR/issue links] |
| 8 | + |
| 9 | +## Context and Problem Statement |
| 10 | + |
| 11 | +[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] |
| 12 | + |
| 13 | +## Decision Drivers <!-- optional --> |
| 14 | + |
| 15 | +* [driver 1, e.g., a force, facing concern, …] |
| 16 | +* [driver 2, e.g., a force, facing concern, …] |
| 17 | +* … <!-- numbers of drivers can vary --> |
| 18 | + |
| 19 | +## Considered Options <!-- numbers of options can vary --> |
| 20 | + |
| 21 | +#### [Option 1] |
| 22 | + |
| 23 | +[example | description | pointer to more information | …] |
| 24 | + |
| 25 | +**Pros:** |
| 26 | + |
| 27 | +* Good, because [argument …] |
| 28 | + |
| 29 | +**Cons:** |
| 30 | + |
| 31 | +* Bad, because [argument …] |
| 32 | + |
| 33 | +#### [Option 2] |
| 34 | +... |
| 35 | + |
| 36 | +#### [Option 3] |
| 37 | +... |
| 38 | + |
| 39 | +## Decision Outcome |
| 40 | + |
| 41 | +Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)]. |
| 42 | + |
| 43 | +### Positive Consequences <!-- optional --> |
| 44 | + |
| 45 | +* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] |
| 46 | +* … |
| 47 | + |
| 48 | +### Negative Consequences <!-- optional --> |
| 49 | + |
| 50 | +* [e.g., compromising quality attribute, follow-up decisions required, …] |
| 51 | +* … |
| 52 | + |
| 53 | +## Links <!-- optional --> |
| 54 | + |
| 55 | +* [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) --> |
| 56 | +* … <!-- numbers of links can vary --> |
0 commit comments