docs(adr): setup ADR process 0001 (#3405)

runatlantis · May 13, 2023 · c3c2fd4 · c3c2fd4
1 parent 4e867fc
commit c3c2fd4
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.adr-dir 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
@@ -0,0 +1,20 @@
+# 1. Record architecture decisions
+
+Date: 2023-05-09
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made for Atlantis. The project is a very decentralized project. It suffers from frequent one-timer contributors and an ever-changing team of maintainers.
+By utilizing the ADR process, we can improve who decisions are made and bring transparency to past decisions to assist future contributors and maintainers to confidently steer the 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) before submitting a new ADR.