"Markdown Architectural Decision Records" (MADR)
[ˈmæɾɚ]
– architectural decisions that matter[ˈmæɾɚ]
.
For user documentation, please head to https://adr.github.io/madr/.
-
MADR follows Semantic Versioning 2.0.0 and documents changes in a
CHANGELOG.md
following keep a changelog 1.0.0. -
Issues can be reported at https://github.com/adr/madr/issues.
-
Use the Markdown Style Guide
space-sentence:1, wrap:sentence, header:atx, list-marker:asterisk, list-space:1, code:fenced
-
Use markdownlint
-
template/adr-template.md
is mirrored todocs/decisions/adr-template
. However, following YAML front matter is added to make it handled properly by the Just the Docs Jekyll Template.--- parent: Decisions nav_order: 100 title: ADR Template ---
- Update
CHANGELOG.md
. - Update the example at
docs/index.md
. - Update
docs/decisions/*
with the new template - Check that the YAML front madder in
docs/decisions/adr-template.md
is kept. - Copy
.markdownlint.yml
totemplate/.markdownlint.yml
- Adapt the version reference in
template/0000-use-markdown-architectural-decision-records.md
. - Copy
template/0000-use-markdown-architectural-decision-records.md
todocs/decisions/0000-use-markdown-architectural-decision-records.md
. - Update
package.json
, publish to npmjs, create GitHub release.
Use release-it (do not create a release on GitHub) and github-release-from-changelog.
This work is dual-licensed under MIT and CC0. You can choose between one of them if you use this work.
SPDX-License-Identifier: MIT OR CC0-1.0