madr - npm Package Versions

[4.0.0] – 2024-09-17

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

• Bare an minimal templates: #88
  • adr-template-minmal.md only contains mandatory sections, with explanations about them. <!-- ### Consequences also contained, though marked as "optional" -->
  • adr-template-bare.md has all sections, wich are empty (no explanations).
  • adr-template-bare-minimal.md has the mandatory sections, without explanations. <!-- ### Consequences also contained, though marked as "optional" -->
• Added example for "Confirmation". #135

Changed

• Put the content of status: in quotes to tell YAML it's a string. #91
• Renamed "Validation" to "Confirmation" and put it as sub element of "Decision Outcome". #87
• Renamed "Deciders" to "Decision Maker(s)" (decision-makers:). #101
• Rename template name "Markdown Any Decision Record" back to "Markdown Architectural Decision Record"
• Rename 0000-use-markdown-any-decision-records.md to 0000-use-madr.md.
• All placehodlers are are now one liners.

Removed

• Removed link to ADR in status field. Only identifier should be put. #150

[3.0.0] – 2022-10-09

Added

• Added comments to markdownlint rules in .markdownlint.yml files.

Changed

• Moved section "Validation" directly after "Decision Outcome"
• Merged sections "Positive Consequences" and "Negative Consequences" into "Consequences" to enable similar grammar as in "Pros and Cons of the Options". #75

Removed

• Removed allowed punctuation in .markdownlint.yml rule

[3.0.0-beta.2] – 2022-05-25

Added

• Added front matter fields "consulted" and "informed" (inspired by RACI). #62
• Added section "Validation"

Changed

• Moved markings for optional content from next to the heading above the heading

[3.0.0-beta] – 2022-05-17

Added

• Added YAML front matter to docs/decisions/adr-template.md
• Added "Neutral" arguments (in addition to "Good, because", and "Bad, because")
• Refined howto texts
• Disable markdown-lint's MD013 - line length for the ADR files.
• Added initial markdownlint configuration file .markdownlint. This can, for instance, be used by a GitHub linting workflow

Changed

• Rename "Markdown Architectural Decision Record" to "Markdown Any Decision Record"
• Place holders for values are denoted by curly braces ({placehodler}). Before it was [placeholder]. #35
• Directory of ADRs changed from docs/adr to docs/decisions. #33
• Renamed template.md to adr-template.md. #36
• Changed ## Links to ## More information
• Relaxed content of More information section from a bullet list to free text.
• Changed optional to This is an optional element. Feel free to remove. to make it more clear how to work with an optional element.
• Changed driver 1 to decision driver 1.
• Changed e.g., compromising quality attribute, follow-up decisions required, … to e.g., compromising one or more desired qualities, …
• Moved the fields to the YAML front matter
• Renamed 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).
• Replace {option 1} place holder to {title of option 1}.
• Restructured and streamlined documentation.

Removed

• Removed Technical Story: {description | ticket/issue URL} <!-- optional -->, because all description should go into "Context and Problem Statement"
• Removed files .adr-dir and .adr-type as tooling should automatically detect the style of the template

[2.1.2] – 2019-02-17

Added

• Add more status fields. Source: #20.

Fixed

• Fixed typos in README.md.

[2.1.1] – 2019-01-21

Fixed

• Fix typo in heading. Fixes #18

[2.1.0] – 2018-06-14

Changed

• Headings "Positive/negative consequences" now full h3 headings instead of text headings
• Adapted internal ADRs to new format

Added

• Added ADR-0011 stating that we use an asterisk as list marker

[2.0.3] – 2018-03-21

Fixed

• Fix reference to MADR version in ADR-0000 and README.md

[2.0.2] – 2018-03-16

Changed

• Streamlined template's ADR-0000.
• Streamlined template by using ellipsis and removing double empty lines.