Releases: adr/madr
Releases · adr/madr
3.0.0
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
3.0.0-beta
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
todocs/decisions
. #33 - Renamed
template.md
toadr-template.md
. #36 - Changed
## Links
to## More information
- Relaxed content of
More information
section from a bullet list to free text. - Changed
optional
toThis is an optional element. Feel free to remove.
to make it more clear how to work with an optional element. - Changed
driver 1
todecicion driver 1
. - Changed
e.g., compromising quality attribute, follow-up decisions required, …
toe.g., compromising one or more desired qualities, …
- Moved the fields to the YAML front matter
- Renamed
template/index.md
totemplate/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 indocs/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
2.1.1
2.1.0
2.0.3
2.0.2
2.0.1
Release 2.0.0
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)