From 448f143fadf33ada4595ceabc0dd6c9c1aa079ff Mon Sep 17 00:00:00 2001 From: Tim Condit Date: Sat, 9 Feb 2019 16:17:28 -0800 Subject: [PATCH 1/2] Update README.md phrasing --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a7af3bd..12e1a53 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ 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. 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). -Do not take the term "architecture" too serious or interpret it too strong. -As the examples illustrate, any decision might have impact on the architecture somehow are architectural decisions. +Do not take the term "architecture" too seriously or interpret it too strongly. +As the examples illustrate, any decision that might have an impact on the architecture somehow is an architectural decision. It should be as easy as possible to a) write down the decisions and @@ -22,7 +22,7 @@ This repository offers a solution to record architectural decisions. It provides files to document Architectural Decisions using **M**arkdown and **A**rchitectural **D**ecision **R**ecords. The decisions are placed in the folder `docs/adr` to -1) Enable [GitHub pages](https://pages.github.com/) to render it using in the web. +1) Enable [GitHub pages](https://pages.github.com/) to render it using the web. See for more information. 2) Separate the architectural decisions from other documentation. @@ -51,7 +51,7 @@ The template reads as follows: ```markdown # [short title of solved problem and solution] -* Status: [accepted | superseeded by [ADR-0005](0005-example.md) | deprecated | …] +* Status: [accepted | superseded by [ADR-0005](0005-example.md) | deprecated | …] * Deciders: [list everyone involved in the decision] * Date: [YYYY-MM-DD when the decision was last updated] @@ -158,7 +158,7 @@ Chosen option: "MADR 2.1.0", because The example is rendered at [template/0000-use-markdown-architectural-decision-records.md](template/0000-use-markdown-architectural-decision-records.md) -For the MADR project itself, all ADRs are exist at [docs/adr/](docs/adr/). +For the MADR project itself, all ADRs exist at [docs/adr/](docs/adr/). ## Apply it to your project From 2a28b5268dc9a7da23ff1c5771b81a13cd80c655 Mon Sep 17 00:00:00 2001 From: Tim Condit Date: Sat, 9 Feb 2019 16:22:04 -0800 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 12e1a53..80539e7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ 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. 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). Do not take the term "architecture" too seriously or interpret it too strongly. -As the examples illustrate, any decision that might have an impact on the architecture somehow is an architectural decision. +As the examples illustrate, any decisions that might have an impact on the architecture somehow are architectural decisions. It should be as easy as possible to a) write down the decisions and