Merge pull request #80 from sebastian-toepfer/adr

add basic architectur doc infra
sebastian-toepfer · Jan 5, 2024 · 5325391 · 5325391
2 parents b05c5b1 + 9a55911
commit 5325391
Show file tree

Hide file tree

Showing 4 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/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "tools/adr"]
+	path = tools/adr
+	url = [email protected]:npryce/adr-tools.git
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: 2024-01-05
+
+## 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).
diff --git a/tools/adr b/tools/adr