Skip to content

Commit d05516c

Browse files
authored
Merge pull request #1507 from json-schema-org/gregsdennis/adr-template-merge-pro-con-into-options
update adr template to merge pros/cons and option descriptions
2 parents a8893b3 + 6078e6f commit d05516c

File tree

1 file changed

+17
-24
lines changed

1 file changed

+17
-24
lines changed

adr/template.md

+17-24
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,9 @@ Technical Story: [description | ticket/issue URL] <!-- optional -->
1818

1919
## Considered Options
2020

21-
* [option 1]
22-
* [option 2]
23-
* [option 3]
24-
*<!-- numbers of options can vary -->
25-
26-
## Decision Outcome
27-
28-
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)].
29-
30-
### Positive Consequences <!-- optional -->
31-
32-
* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
33-
*
34-
35-
### Negative Consequences <!-- optional -->
36-
37-
* [e.g., compromising quality attribute, follow-up decisions required, …]
38-
*
39-
40-
## Pros and Cons of the Options <!-- optional -->
41-
4221
### [option 1]
4322

44-
[example | description | pointer to more information | …] <!-- optional -->
23+
[example | description | pointer to more information | …]
4524

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

5130
### [option 2]
5231

53-
[example | description | pointer to more information | …] <!-- optional -->
32+
[example | description | pointer to more information | …]
5433

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

6039
### [option 3]
6140

62-
[example | description | pointer to more information | …] <!-- optional -->
41+
[example | description | pointer to more information | …]
6342

6443
* Good, because [argument a]
6544
* Good, because [argument b]
6645
* Bad, because [argument c]
6746
*<!-- numbers of pros and cons can vary -->
6847

48+
## Decision Outcome
49+
50+
"[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)].
51+
52+
### Positive Consequences <!-- optional -->
53+
54+
* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
55+
*
56+
57+
### Negative Consequences <!-- optional -->
58+
59+
* [e.g., compromising quality attribute, follow-up decisions required, …]
60+
*
61+
6962
## Links <!-- optional -->
7063

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

0 commit comments

Comments
 (0)