Skip to content

Commit

Permalink
docs(adr): setup ADR process 0001 (runatlantis#3405)
Browse files Browse the repository at this point in the history
  • Loading branch information
GenPage authored and ijames-gc committed Feb 13, 2024
1 parent 3380ba8 commit 3f5c8cc
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions .adr-dir
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/adr
20 changes: 20 additions & 0 deletions docs/adr/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3f5c8cc

Please sign in to comment.