Bot releases are hidden (Show)
adr-template-minmal.md
only contains mandatory sections, with explanations about them.
adr-template-bare.md
has all sections, wich are empty (no explanations).adr-template-bare-minimal.md
has the mandatory sections, without explanations.
status:
in quotes to tell YAML it's a string. #91
decision-makers:
). #101
0000-use-markdown-any-decision-records.md
to 0000-use-madr.md
.status
field. Only identifier should be put. #150
Published by koppor about 2 years ago
.markdownlint.yml
files..markdownlint.yml
rulePublished by koppor over 2 years ago
Published by koppor over 2 years ago
docs/decisions/adr-template.md
.markdownlint
.{placehodler}
). Before it was [placeholder]
. #35
docs/adr
to docs/decisions
. #33
template.md
to adr-template.md
. #36
## Links
to ## More information
More information
section from a bullet list to free text.optional
to This is an optional element. Feel free to remove.
to make it more clear how to work with an optional element.driver 1
to decicion driver 1
.e.g., compromising quality attribute, follow-up decisions required, …
to e.g., compromising one or more desired qualities, …
template/index.md
to template/README.md
, because i) README.md
is directly rendered on GitHub and ii) for Jekyll-based rendering, the index file has to be adapted (e.g., to show a hint to the doc as MADR does in docs/decisions/index.md
).{option 1}
place holder to {title of option 1}
.Technical Story: {description | ticket/issue URL} <!-- optional -->
, because all description should go into "Context and Problem Statement".adr-dir
and .adr-type
as tooling should automatically detect the style of the templatePublished by koppor over 6 years ago
Published by koppor over 6 years ago
Published by koppor over 6 years ago
Published by koppor over 6 years ago
Published by koppor over 6 years ago
*
(instead of -
at some lists)Published by koppor over 6 years ago
README.md
: Added wints on the filenames.LICENSE
fileREADME.md
: Removed section "Background Information" as the information is contained at http://adr.github.io, too. Fixes #4
Published by koppor over 6 years ago
md
filesmd
filesPublished by koppor over 6 years ago
+
and -
by "Good, because ..." and "Bad, because ..."Published by koppor over 6 years ago
npm
.*[PLACEHOLDER]*
to [PLACEHOLDER]
to have a single pair of enclosing characters ([]
) instead of two (*[]*
).argument 1 pro
to pro point
and argument 1 con
to con point
Published by koppor almost 7 years ago
package.json
and fix name.Published by koppor almost 7 years ago
docs/adr/index.md
.template.md
is not part of the log, but a separate text block in docs/adr/index.md
.README.md
.docs/adr/index.md
.docs/adr/0000-use-markdown-architectural-decision-records.md
.