Refine templates (#155)

- Use "<!-- ->" instead of "{...}" for place holders - Add proposed text to adr-template-bare - Re-add quotes around chosen option
adr · Sep 5, 2024 · d376c6f · d376c6f
1 parent d6ba5a9
commit d376c6f
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+### Fixed
+
+- `adr-template.md`: Re-add quotes around chosen option name.
+- `adr-template-minimal.md`: Place holder in one line.
+- `adr-template-bare.md`: Keep fixed template text as normal markdown (and not as comment).
+- `adr-template-bare.md` and `adr-template-bare-minimal.md`: Always use `<!-- … ->` als place holder instead of `{…}`.
+
 ## [4.0.0-beta] – 2024-09-02
 
 ### Added

diff --git a/docs/decisions/adr-template.md b/docs/decisions/adr-template.md
@@ -35,7 +35,7 @@ title: ADR Template
 
 ## Decision Outcome
 
-Chosen option: {title of option 1}, because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
 
 <!-- This is an optional element. Feel free to remove. -->
 ### Consequences

diff --git a/template/adr-template-bare-minimal.md b/template/adr-template-bare-minimal.md
@@ -1,5 +1,4 @@
-
-# {short title, representative of solved problem and found solution}
+# <!-- short title, representative of solved problem and found solution -->
 
 ## Context and Problem Statement
 
@@ -15,4 +14,3 @@
 
 ### Consequences
 
-
diff --git a/template/adr-template-bare.md b/template/adr-template-bare.md
@@ -6,7 +6,7 @@ consulted:
 informed: 
 ---
 
-# {short title, representative of solved problem and found solution}
+# <!-- short title, representative of solved problem and found solution -->
 
 ## Context and Problem Statement
 
@@ -22,23 +22,23 @@ informed:
 
 ## Decision Outcome
 
-
+Chosen option: "", because
 
 ### Consequences
 
-* <!-- * Good, because -->
-* <!-- * Bad, because -->
+* Good, because
+* Bad, because
 
 ### Confirmation
 
 
 
 ## Pros and Cons of the Options
 
-### {title of option}
+### <!-- title of option -->
 
-* <!-- * Good, because -->
-* <!-- * Neutral, because -->
-* <!-- * Bad, because -->
+* Good, because
+* Neutral, because
+* Bad, because
 
 ## More Information
diff --git a/template/adr-template-minimal.md b/template/adr-template-minimal.md
@@ -13,8 +13,7 @@
 
 ## Decision Outcome
 
-Chosen option: "{title of option 1}", because
-{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
 
 <!-- This is an optional element. Feel free to remove. -->
 ### Consequences

diff --git a/template/adr-template.md b/template/adr-template.md
@@ -29,7 +29,7 @@ informed: {list everyone who is kept up-to-date on progress; and with whom there
 
 ## Decision Outcome
 
-Chosen option: {title of option 1}, because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+Chosen option: "{title of option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
 
 <!-- This is an optional element. Feel free to remove. -->
 ### Consequences