Releases: adr/madr
Releases · adr/madr
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)
Version 1.4.0
Added
- Version of MADR into ADR-0000 of the template. Fixes #5
README.md
: Added wints on the filenames.- More ADRs on MADR
- Added
LICENSE
file
Changed
README.md
: Removed section "Background Information" as the information is contained at http://adr.github.io, too. Fixes #4
Version 1.3.1
Fixed
- Replace "alternative" by "option" in all
md
files - Update to new "Decision Outcome" format in all
md
files
Version 1.3.0
Changed
- Changed template to be closer to the Y-Statements.
Especially rename "alternative" to "option" - Restructured syntax of "Decision Outcome".
Positive and negative consequences as separate bullet list. - Rename "point" to "argument" (which reverts the change of version 1.2.0)
- Number "arguments" from a to c. Re-use "variables" a to c to guide the author that the same topic should be handled by the enumeration. e..g, performance, ...
- Exchange
+
and-
by "Good, because ..." and "Bad, because ..." - Remove emphasize of "User Story:"
Version 1.2.0
Added
- Add installation instructions using
npm
.
Changed
- Placeholders changed from
*[PLACEHOLDER]*
to[PLACEHOLDER]
to have a single pair of enclosing characters ([]
) instead of two (*[]*
). - Rename
argument 1 pro
topro point
andargument 1 con
tocon point
1.1.1
1.1.0
Changed
- No change in the template itself.
- Use adr-log to generate links to the ADRs in
docs/adr/index.md
. template.md
is not part of the log, but a separate text block indocs/adr/index.md
.- Link to new homepage of MADR: https://adr.github.io/madr/.
- Refined justification of ADR-0000.
- Refined
README.md
.
Fixed
- Fixed internal links in
docs/adr/index.md
. - Fixed typo in
docs/adr/0000-use-markdown-architectural-decision-records.md
.