Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add template and number prefix to ADRs docs #728

Merged
merged 1 commit into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
74 changes: 74 additions & 0 deletions docs/adrs/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# [short title of solved problem and solution]

- Status: [proposed | rejected | accepted | deprecated | … | superseded by
[ADR-0005](0005-example.md)] <!-- optional -->
- Date: [YYYY-MM-DD when the decision was last updated] <!-- optional -->

Tracking issue: [ticket/issue URL] <!-- optional -->

## Context and Problem Statement

[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.]

## Decision Drivers <!-- optional -->

- [driver 1, e.g., a force, facing concern, …]
- [driver 2, e.g., a force, facing concern, …]
- … <!-- numbers of drivers can vary -->

## Considered Options

1. [option 1]
2. [option 2]
3. [option 3]
4. … <!-- numbers of options can vary -->

## Decision Outcome

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)].

### Positive Consequences <!-- optional -->

- [e.g., improvement of quality attribute satisfaction, follow-up decisions
required, …]
- …

### Negative Consequences <!-- optional -->

- [e.g., compromising quality attribute, follow-up decisions required, …]
- …

## Pros and Cons of the Options <!-- optional -->

### Option 1 - …

[example | description | pointer to more information | …] <!-- optional -->

- Good, because [argument a]
- Bad, because [argument b]
- … <!-- numbers of pros and cons can vary -->

### Option 2 - …

[example | description | pointer to more information | …] <!-- optional -->

- Good, because [argument a]
- Bad, because [argument b]
- … <!-- numbers of pros and cons can vary -->

### Option 3 - …

[example | description | pointer to more information | …] <!-- optional -->

- Good, because [argument a]
- Bad, because [argument b]
- … <!-- numbers of pros and cons can vary -->

## Links <!-- optional -->

- [Link type] [Link to ADR]
<!-- example: Refined by [ADR-0005](0005-example.md) -->
- … <!-- numbers of links can vary -->