Skip to content

update adr template to merge pros/cons and option descriptions #1507

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 10, 2024
Merged

update adr template to merge pros/cons and option descriptions #1507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 17 additions & 24 deletions adr/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,9 @@ Technical Story: [description | ticket/issue URL] <!-- optional -->

## Considered Options

* [option 1]
* [option 2]
* [option 3]
* … <!-- 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 -->
[example | description | pointer to more information | …]

* Good, because [argument a]
* Good, because [argument b]
Expand All @@ -50,7 +29,7 @@ Chosen option: "[option 1]", because [justification. e.g., only option, which me

### [option 2]

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

* Good, because [argument a]
* Good, because [argument b]
Expand All @@ -59,13 +38,27 @@ Chosen option: "[option 1]", because [justification. e.g., only option, which me

### [option 3]

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

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

## Decision Outcome

"[option 1]" was chosen 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, …]
* …

## Links <!-- optional -->

* [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) -->
Expand Down
Loading