(chore) Use ADR for documenting architectural decisions

dxw · Jun 28, 2019 · ec4cfe4 · ec4cfe4
1 parent 9a32f2a
commit ec4cfe4
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/.adr-dir b/.adr-dir
@@ -0,0 +1 @@
+doc/architecture/decisions
diff --git a/README.md b/README.md
@@ -10,6 +10,10 @@ TODO: Add getting started steps
 
 TODO: Add testing instructions
 
+## Architecture decision records
+
+We use ADRs to document architectural decisions that we make. They can be found in doc/architecture/decisions and contributed to with the [adr-tools](https://github.com/npryce/adr-tools).
+
 ## Access
 
 TODO: Where can people find the service and the different environments?
diff --git a/doc/architecture/decisions/0001-record-architecture-decisions.md b/doc/architecture/decisions/0001-record-architecture-decisions.md
@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2019-06-28
+
+## 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).