50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
---
|
|
# status and date are the only required elements. Feel free to remove the rest.
|
|
status: {[proposed | rejected | accepted | deprecated | … | superseded by [ADR-NAME](adr-file-name.md)]}
|
|
date: {YYYY-MM-DD when the decision was last updated}
|
|
builds-on: {[Short Title](2021-05-15-short-title.md)}
|
|
story: {description or link to contextual issue}
|
|
---
|
|
|
|
# {short title of solved problem and solution}
|
|
|
|
## Context and Problem Statement
|
|
|
|
{2-3 sentences explaining the problem and the forces influencing the decision.}
|
|
<!-- The language in this section is value-neutral. It is simply describing facts. -->
|
|
|
|
## Priorities & Constraints <!-- optional -->
|
|
|
|
* {List of concerns or constraints}
|
|
* {Factors influencing the decision}
|
|
|
|
## Considered Options
|
|
|
|
* Option 1: Thing
|
|
* Option 2: Another
|
|
|
|
### Pros and Cons of the Options <!-- optional -->
|
|
|
|
#### Option 1: {Brief description}
|
|
|
|
* Good, because {reason}
|
|
* Bad, because {reason}
|
|
|
|
## Decision Outcome
|
|
|
|
Chosen option [Option 1: Thing]
|
|
|
|
{Clearly state the chosen option and provide justification. Reference the "Pros and Cons of the Options" section below if applicable.}
|
|
|
|
### Expected Consequences <!-- optional -->
|
|
|
|
* List of outcomes resulting from this decision
|
|
<!-- Positive, negative, and/or neutral consequences, as long as they affect the team and project in the future. -->
|
|
|
|
## More Information <!-- optional -->
|
|
|
|
<!-- * Resources reviewed as part of making this decision -->
|
|
<!-- * Links to any supporting documents or resources -->
|
|
<!-- * Related PRs -->
|
|
<!-- * Related User Journeys -->
|