build(docker): add and configure ADR Tools

This commit is contained in:
Oliver Davies 2022-01-12 18:40:04 +00:00
parent 6e773d1301
commit 0f4fe3b8dc
4 changed files with 44 additions and 0 deletions

1
.adr-dir Normal file
View file

@ -0,0 +1 @@
docs/architectural-decisions

View file

@ -11,6 +11,11 @@ x-assets: &default-assets
- ".:/app"
services:
adr-tools:
image: "opdavies/adr-tools"
volumes:
- "./:/adr"
css:
<<: *default-assets
command: "./run yarn:build:css"

View file

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

View file

@ -0,0 +1,19 @@
# 2. Use Sculpin
Date: 2022-01-12
## Status
Accepted
## Context
The issue motivating this decision, and any context that influences or constrains the decision.
## Decision
The change that we're proposing or have agreed to implement.
## Consequences
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.