From 467cc0cf149e4208efd97c491ac9452f4c7f0be9 Mon Sep 17 00:00:00 2001 From: Dylan Page Date: Fri, 12 May 2023 13:55:20 -0400 Subject: [PATCH 1/2] docs(adr): setup ADR process --- .adr-dir | 1 + .../adr/0001-record-architecture-decisions.md | 20 +++++++++++++++++++ 2 files changed, 21 insertions(+) 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 0000000000..c73b64aed2 --- /dev/null +++ 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 new file mode 100644 index 0000000000..d1d4c1a087 --- /dev/null +++ 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 ever changing team of maintainers. +By utilizing the ADR process, we can improve who decisions are made and bring transparency to past decisions to avoid 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. From 34fbf36e622f881ee6ba78ed0db3819c13130758 Mon Sep 17 00:00:00 2001 From: Dylan Page Date: Fri, 12 May 2023 13:57:54 -0400 Subject: [PATCH 2/2] docs(adr): grammar tweaks --- docs/adr/0001-record-architecture-decisions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md index d1d4c1a087..b0dfda2419 100644 --- a/docs/adr/0001-record-architecture-decisions.md +++ b/docs/adr/0001-record-architecture-decisions.md @@ -8,8 +8,8 @@ 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 ever changing team of maintainers. -By utilizing the ADR process, we can improve who decisions are made and bring transparency to past decisions to avoid future contributors and maintainers to confidently steer the project. +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