From f9bafe092da8665d73cbffe2368db07cf794ec6b Mon Sep 17 00:00:00 2001 From: Sunshine Date: Wed, 25 Dec 2019 19:00:58 -0500 Subject: [PATCH] Introduce ADRs --- .adr-dir | 1 + .../adr/0001-record-architecture-decisions.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .adr-dir create mode 100644 docs/adr/0001-record-architecture-decisions.md diff --git a/.adr-dir b/.adr-dir new file mode 100644 index 0000000..c36d5b8 --- /dev/null +++ b/.adr-dir @@ -0,0 +1 @@ +docs/adr/ diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md new file mode 100644 index 0000000..3064db0 --- /dev/null +++ b/docs/adr/0001-record-architecture-decisions.md @@ -0,0 +1,19 @@ +# 1. Record architecture decisions + +Date: 2019-12-25 + +## Status + +Accepted + +## Context + +We need to record the architectural decisions made on this project. + +## Decision + +We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). + +## Consequences + +See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).