From 4b5edb61f409499463fe017b62e69ac970955514 Mon Sep 17 00:00:00 2001
From: Florian Wilhelm <florian.wilhelm02@sap.com>
Date: Mon, 15 Apr 2024 09:52:38 +0200
Subject: [PATCH] Bootstrap ADR for glvd

---
 .adr-dir                                      |  1 +
 README.md                                     |  3 ++-
 .../adr/0001-record-architecture-decisions.md | 19 +++++++++++++++++++
 3 files changed, 22 insertions(+), 1 deletion(-)
 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..c73b64a
--- /dev/null
+++ b/.adr-dir
@@ -0,0 +1 @@
+docs/adr
diff --git a/README.md b/README.md
index 77c29f6..3336a9a 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ This repository on the other hand contains the actual source code of the Securit
 Thereby, this repostory contains the following directories:
 
 - `docs/`: This directory contains documentation regarding `glvd`.
+  - `adr/`: This directory contains ADRs (Architecture Decision Records), as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
 - `src/`: This directory contains the source files of `glvd`.
   - `glvd/`: The main directory of the Security Tracker.
     - `cli/`: Command Line Interface for running operational tasks on `glvd`.
@@ -34,4 +35,4 @@ The client documentation can be found here: [docs/01_client.md](./docs/01_client
 The server documentation can be found here: [docs/02_server.md](./docs/02_server.md)
 
 ### Ingestion
-The ingestion documentation can be found here: [docs/03_ingestion.md](./docs/03_ingestion.md)
\ No newline at end of file
+The ingestion documentation can be found here: [docs/03_ingestion.md](./docs/03_ingestion.md)
diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md
new file mode 100644
index 0000000..2903149
--- /dev/null
+++ b/docs/adr/0001-record-architecture-decisions.md
@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2024-04-15
+
+## 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).