Skip to content

Commit 87086f8

Browse files
committed
Fix linting issues
1 parent dd7894b commit 87086f8

1 file changed

Lines changed: 31 additions & 33 deletions

File tree

templates/yadr-template-full.yaml

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ metadata:
1010
title: '{short title, representative of solved problem and found solution}'
1111

1212
context-and-problem-statement: |
13-
{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story.
14-
15-
* You may want to articulate the problem in form of a question.
16-
* Consider adding links to collaboration boards or issue management systems.
17-
* Make the scope of the decision explicit, for instance, by calling out or pointing at structural architecture elements (components, connectors, ...).}
13+
{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story.
14+
15+
* You may want to articulate the problem in form of a question.
16+
* Consider adding links to collaboration boards or issue management systems.
17+
* Make the scope of the decision explicit, for instance, by calling out or pointing at structural architecture elements (components, connectors, ...).}
1818
1919
# this is an optional element
2020
decision-drivers:
21-
- '{decision driver 1, e.g., a force, facing concern, …}'
22-
- '{decision driver 2, e.g., a force, facing concern, …}'
23-
- '… <!-- numbers of drivers can vary -->'
21+
- '{decision driver 1, e.g., a force, facing concern, …}'
22+
- '{decision driver 2, e.g., a force, facing concern, …}'
23+
- '… <!-- numbers of drivers can vary -->'
2424

2525
considered-options:
26-
- &id-of-option-1 '{title of option 1}'
27-
- &id-of-option-2 '{title of option 2}'
28-
- &id-of-option-3 '{title of option 3}'
29-
# numbers of options can vary
26+
- &id-of-option-1 '{title of option 1}'
27+
- &id-of-option-2 '{title of option 2}'
28+
- &id-of-option-3 '{title of option 3}'
29+
# numbers of options can vary
3030

3131
# this is an optional element
3232
pros-and-cons-of-the-options:
@@ -38,33 +38,33 @@ pros-and-cons-of-the-options:
3838
{example | description | pointer to more information | …}
3939
4040
pros:
41-
- &argument-a '{argument a}'
42-
- '{argument b}'
43-
# use "neutral" if the given argument weights neither for good nor bad.
41+
- &argument-a '{argument a}'
42+
- '{argument b}'
43+
# use "neutral" if the given argument weights neither for good nor bad.
4444

4545
neutral:
46-
- &argument-c '{argument c}'
46+
- &argument-c '{argument c}'
4747

4848
cons:
49-
- &argument-d '{argument d}'
50-
# numbers of pros and cons can vary
49+
- &argument-d '{argument d}'
50+
# numbers of pros and cons can vary
5151

5252
id-of-option-2:
5353
# same structure as id-of-option-1
5454
description: |
5555
{example | description | pointer to more information | …}
5656
5757
pros:
58-
- &argument-a '{argument a}'
59-
- '{argument b}'
60-
# use "neutral" if the given argument weights neither for good nor bad.
58+
- &argument-a '{argument a}'
59+
- '{argument b}'
60+
# use "neutral" if the given argument weights neither for good nor bad.
6161

6262
neutral:
63-
- &argument-c '{argument c}'
63+
- &argument-c '{argument c}'
6464

6565
cons:
66-
- &argument-d '{argument d}'
67-
# numbers of pros and cons can vary
66+
- &argument-d '{argument d}'
67+
# numbers of pros and cons can vary
6868

6969
decision-outcome:
7070

@@ -79,21 +79,19 @@ decision-outcome:
7979
# this is an optional element
8080
consequences:
8181
positive:
82-
# numbers of entries can vary
83-
- *argument-a
84-
- '{positive consequence, e.g., improvement of one or more desired qualities, …}'
82+
# numbers of entries can vary
83+
- *argument-a
84+
- '{positive consequence, e.g., improvement of one or more desired qualities, …}'
8585
neutral:
86-
- *argument-c
87-
- '{neutral consequence, e.g., resulting activity, new requirement/decision, …}'
86+
- *argument-c
87+
- '{neutral consequence, e.g., resulting activity, new requirement/decision, …}'
8888
negative:
89-
- *argument-d
90-
- '{negative consequence, e.g., compromising one or more desired qualities, …}'
89+
- *argument-d
90+
- '{negative consequence, e.g., compromising one or more desired qualities, …}'
9191

9292
# this is an optional element
9393
confirmation: |
94-
9594
{Describe how the implementation / compliance of the ADR can/will be confirmed. Is there any automated or manual fitness function? If so, list it and explain how it is applied. Is the chosen design and its implementation in line with the decision? E.g., a design/code review or a test with a library such as ArchUnit can help validate this. Note that although we classify this element as optional, it is included in many ADRs.}
9695
9796
more-information: |
98-
9997
{You might want to provide additional evidence/confidence for the decision outcome here and/or document the team agreement on the decision and/or define when/how this decision the decision should be realized and if/when it should be re-visited. Links to other decisions and resources might appear here as well.}

0 commit comments

Comments
 (0)