Skip to content

Releases: adr/madr

3.0.0

09 Oct 19:31
Compare
Choose a tag to compare

Added

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

24 May 22:12
Compare
Choose a tag to compare

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

17 May 19:21
Compare
Choose a tag to compare

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 decicion 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

17 Feb 11:06
Compare
Choose a tag to compare

Added

  • Add more status fields. Source: #20.

Fixed

  • Fixed typos in README.md.

2.1.1

21 Jan 20:52
Compare
Choose a tag to compare

Fixed

  • Fix typo in heading. Fixes #18

2.1.0

14 Jun 06:52
Compare
Choose a tag to compare

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

21 Mar 16:02
Compare
Choose a tag to compare

Fixed

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

2.0.2

16 Mar 13:29
Compare
Choose a tag to compare

Changed

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

2.0.1

07 Mar 09:53
Compare
Choose a tag to compare

Fixed

  • State MADR 2.0.1 also in template's ADR-0000.

Release 2.0.0

07 Mar 08:38
Compare
Choose a tag to compare

Added

  • Optional: Status, Deciders, Date. Fixes #2.
  • More explanations of options can now be put next to each option
  • Links to other ADRs added at the bottom of the ADR

Changed

  • Rename "User Story" to "Technical Story"
  • "Context and Problem Statement" and "Decision Drivers" are a heading now
  • The chosen option is now written in quotes to separate the name from the rest of the text
  • All bullet lists are now made using * (instead of - at some lists)