From 94cdf24ded519ae275945c3201256e8dd2e54040 Mon Sep 17 00:00:00 2001 From: Sebastian Toepfer <61313468+sebastian-toepfer@users.noreply.github.com> Date: Fri, 5 Jan 2024 18:16:45 +0100 Subject: [PATCH 1/2] add adr-tool for managing the adr files --- .gitmodules | 3 +++ tools/adr | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 tools/adr diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..e1e5d7a0 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "tools/adr"] + path = tools/adr + url = git@github.com:npryce/adr-tools.git diff --git a/tools/adr b/tools/adr new file mode 160000 index 00000000..b3279baf --- /dev/null +++ b/tools/adr @@ -0,0 +1 @@ +Subproject commit b3279baf9be2207d1a4f4bbd608fd0b591c72aee From b7d0b4e103c5c98150696db1eb131b04c86ba37f Mon Sep 17 00:00:00 2001 From: Sebastian Toepfer <61313468+sebastian-toepfer@users.noreply.github.com> Date: Fri, 5 Jan 2024 18:17:02 +0100 Subject: [PATCH 2/2] add first ADR --- .adr-dir | 1 + .../0001-record-architecture-decisions.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .adr-dir create mode 100644 doc/architecture/decisions/0001-record-architecture-decisions.md diff --git a/.adr-dir b/.adr-dir new file mode 100644 index 00000000..0d38988a --- /dev/null +++ b/.adr-dir @@ -0,0 +1 @@ +doc/architecture/decisions diff --git a/doc/architecture/decisions/0001-record-architecture-decisions.md b/doc/architecture/decisions/0001-record-architecture-decisions.md new file mode 100644 index 00000000..b9acda73 --- /dev/null +++ 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).