Skip to content

Commit 8a6ea2a

Browse files
authored
feat: Introduce ADRs (#979)
1 parent 86929df commit 8a6ea2a

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

.adr-dir

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc/architecture/decisions

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,10 @@ Running `docker-compose up` won't spin up [metabase](https://www.metabase.com/).
2424
To spin it up, run:
2525

2626
`docker-compose --profile analytics up`
27+
28+
29+
#### Documentation
30+
31+
This project uses Architecture Decision Records (ADRs) to record significant changes and decisions. Further details of this can be (found here)[https://github.com/theopensystemslab/planx-new/blob/main/doc/architecture/decisions/0001-record-architecture-decisions.md].
32+
33+
For maximum visibility and discoverability, we recommend using the (GithHub discussions board)[https://github.com/theopensystemslab/planx-new/discussions] where possible.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 1. Record architecture decisions
2+
3+
Date: 2022-06-28
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
We need to record the architectural decisions made on this project.
12+
13+
## Decision
14+
15+
We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
16+
17+
## Consequences
18+
19+
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

0 commit comments

Comments
 (0)