Merge pull request #111 from snshn/adr

Introduce ADRs
This commit is contained in:
Sunshine 2020-01-22 23:57:25 -05:00 committed by GitHub
commit 1e8348543a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 0 deletions

1
.adr-dir Normal file
View file

@ -0,0 +1 @@
docs/adr/

View file

@ -0,0 +1,19 @@
# 1. Record architecture decisions
Date: 2019-12-25
## 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).