madr - npm Package Compare versions
Comparing version 2.0.3 to 2.1.0
@@ -8,4 +8,15 @@ # Changelog | ||
| ## [2.0.3] - 2018-03-21 | ||
| ## [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 | ||
@@ -15,3 +26,3 @@ | ||
| ## [2.0.2] - 2018-03-16 | ||
| ## [2.0.2] – 2018-03-16 | ||
@@ -23,3 +34,3 @@ ### Changed | ||
| ## [2.0.1] - 2018-03-07 | ||
| ## [2.0.1] – 2018-03-07 | ||
@@ -30,3 +41,3 @@ ### Fixed | ||
| ## [2.0.0] - 2018-03-07 | ||
| ## [2.0.0] – 2018-03-07 | ||
@@ -46,3 +57,3 @@ ### Added | ||
| ## [1.4.0] - 2018-03-01 | ||
| ## [1.4.0] – 2018-03-01 | ||
@@ -117,3 +128,4 @@ ### Added | ||
| [Unreleased]: https://github.com/adr/madr/compare/2.0.3...master | ||
| [Unreleased]: https://github.com/adr/madr/compare/2.1.0...master | ||
| [2.1.0]: https://github.com/adr/madr/compare/2.0.3...2.1.0 | ||
| [2.0.3]: https://github.com/adr/madr/compare/2.0.2...2.0.3 | ||
@@ -120,0 +132,0 @@ [2.0.2]: https://github.com/adr/madr/compare/2.0.1...2.0.2 |
@@ -14,3 +14,3 @@ { | ||
| ], | ||
| "version": "2.0.3", | ||
| "version": "2.1.0", | ||
| "homepage": "https://adr.github.io/madr/", | ||
@@ -17,0 +17,0 @@ "author": "Oliver Kopp (http://github.com/koppor/)", |
@@ -5,2 +5,9 @@ # Markdown Architectural Decision Records [](https://adr.github.io) | ||
| ## News | ||
| - 2018-04-13: Mentioned in [@vanto](https://github.com/vanto)'s presentation about ADRs: <https://speakerdeck.com/vanto/a-brief-introduction-to-architectural-decision-records>. | ||
| - 2018-04-03: Scientific publication: [Markdown Architectural Decision Records: Format and Tool Support](http://ceur-ws.org/Vol-2072/paper9.pdf). | ||
| ## Overview | ||
| An [Architectural Decision (AD)](https://en.wikipedia.org/wiki/Architectural_decision) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant. | ||
@@ -24,2 +31,3 @@ This might, for instance, be a technology choice (e.g., Java vs. JavaScript), a choice of the IDE (e.g., IntelliJ vs. Eclipse IDE), a choice between a library (e.g., [SLF4J](https://www.slf4j.org/) vs [java.util.logging](https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html)), or a decision on features (e.g., infinite undo vs. limited undo). | ||
| The filenames are following the pattern `NNNN-title-with-dashes.md` ([ADR-0005](docs/adr/0005-use-dashes-in-filenames.md)), where | ||
| - `NNNN` is a consecutive number and we assume that there won't be more than 1000 ADRs in one repository. | ||
@@ -75,7 +83,9 @@ - the title is stored using dashes and lowercase, because [adr-tools] also does that. | ||
| Positive Consequences: <!-- optional --> | ||
| ### Positive Consequences <!-- optional --> | ||
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] | ||
| * … | ||
| Negative consequences: <!-- optional --> | ||
| ### Negative consequences <!-- optional --> | ||
| * [e.g., compromising quality attribute, follow-up decisions required, …] | ||
@@ -119,3 +129,3 @@ * … | ||
| The template is available at [template/template.md](template/template.md). | ||
| The template is available at [template/template.md](https://github.com/adr/madr/blob/master/template/template.md). | ||
@@ -134,3 +144,3 @@ ## Example | ||
| * [MADR](https://adr.github.io/madr/) 2.0.3 - The Markdown Architectural Decision Records | ||
| * [MADR](https://adr.github.io/madr/) 2.1.0 - The Markdown Architectural Decision Records | ||
| * [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) - The first incarnation of the term "ADR" | ||
@@ -143,3 +153,4 @@ * [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) - The Y-Statements | ||
| Chosen option: "MADR 2.0.3", because | ||
| Chosen option: "MADR 2.1.0", because | ||
| * Implicit assumptions should be made explicit. | ||
@@ -151,3 +162,3 @@ Design documentation is important to enable people understanding the decisions later on. | ||
| * The MADR project is vivid. | ||
| * Version 2.0.3 is the latest one available when starting to document ADRs. | ||
| * Version 2.1.0 is the latest one available when starting to document ADRs. | ||
| ``` | ||
@@ -169,3 +180,3 @@ | ||
| ```sh | ||
| $ npm install madr && mkdir -p docs/adr && cp node_modules/madr/template/* docs/adr/ | ||
| npm install madr && mkdir -p docs/adr && cp node_modules/madr/template/* docs/adr/ | ||
| ``` | ||
@@ -198,5 +209,6 @@ | ||
| 1. Update `CHANGELOG.md`. | ||
| 1. Update `README.md` with the new template and the example. | ||
| 1. Adapt the version reference in `template/0000-use-markdown-architectural-decision-records.md`. | ||
| 1. Copy `template/0000-use-markdown-architectural-decision-records.md` to `docs/adr/0000-use-markdown-architectural-decision-records.md`. | ||
| 1. Update `package.json`, publish to [npmjs](https://www.npmjs.com/package/madr), create GitHub release.<br> | ||
| 1. Update `package.json`, publish to [npmjs](https://www.npmjs.com/package/madr), create GitHub release. | ||
| Use [release-it](https://www.npmjs.com/package/release-it) (do not create a release on GitHub) and [github-release-from-changelog](https://www.npmjs.com/package/github-release-from-changelog). | ||
@@ -203,0 +215,0 @@ |
@@ -10,3 +10,3 @@ # Use Markdown Architectural Decision Records | ||
| * [MADR](https://adr.github.io/madr/) 2.0.3 - The Markdown Architectural Decision Records | ||
| * [MADR](https://adr.github.io/madr/) 2.1.0 - The Markdown Architectural Decision Records | ||
| * [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) - The first incarnation of the term "ADR" | ||
@@ -19,3 +19,4 @@ * [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) - The Y-Statements | ||
| Chosen option: "MADR 2.0.3", because | ||
| Chosen option: "MADR 2.1.0", because | ||
| * Implicit assumptions should be made explicit. | ||
@@ -27,2 +28,2 @@ Design documentation is important to enable people understanding the decisions later on. | ||
| * The MADR project is vivid. | ||
| * Version 2.0.3 is the latest one available when starting to document ADRs. | ||
| * Version 2.1.0 is the latest one available when starting to document ADRs. |
@@ -30,7 +30,9 @@ # [short title of solved problem and solution] | ||
| Positive Consequences: <!-- optional --> | ||
| ### Positive Consequences <!-- optional --> | ||
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …] | ||
| * … | ||
| Negative consequences: <!-- optional --> | ||
| ### Negative consequences <!-- optional --> | ||
| * [e.g., compromising quality attribute, follow-up decisions required, …] | ||
@@ -37,0 +39,0 @@ * … |
Improved metrics
- Total package byte prevSize
- increased by3.16%
25299
- Number of lines in readme file
- increased by6%
212