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

Pros/Cons as headings #141

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft
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
48 changes: 36 additions & 12 deletions template/adr-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,13 @@ Chosen option: "{title of option 1}", because
<!-- This is an optional element. Feel free to remove. -->
### Consequences

* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
Positive Consequences:

* {positive consequence, e.g., improvement of one or more desired qualities, …}

Negative Consequences:

* {negative consequence, e.g., compromising one or more desired qualities, …}
* … <!-- numbers of consequences can vary -->

<!-- This is an optional element. Feel free to remove. -->
Expand All @@ -53,22 +58,41 @@ Chosen option: "{title of option 1}", because
<!-- This is an optional element. Feel free to remove. -->
{example | description | pointer to more information | …}

* Good, because {argument a}
* Good, because {argument b}
Pros:

* {argument a}
* {argument b}

<!-- use "neutral" if the given argument weights neither for good nor bad -->
* Neutral, because {argument c}
* Bad, because {argument d}
* … <!-- numbers of pros and cons can vary -->
Neutral:

* {argument c}
* {argument d}

Cons:

* {argument e}
* {argument f}
* … <!-- numbers of arguments can vary -->

### {title of other option}

{example | description | pointer to more information | …}

* Good, because {argument a}
* Good, because {argument b}
* Neutral, because {argument c}
* Bad, because {argument d}
* …
Pros:

* {argument g}
* {argument h}

Neutral:

* {argument i}
* {argument j}

Cons:

* {argument k}
* {argument l}

<!-- This is an optional element. Feel free to remove. -->
## More Information
Expand Down