Skip to content

Commit baf1a2c

Browse files
committed
Document decision to use ADRs
Why these changes are being introduced: We are about to make major architectural decisions about this application, and we need a framework for recording them. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/GDT-123 How this addresses that need: This adds an initial architectural decision record (ADR) to confirm that we will use ADRs in this repo. Side effects of this change: Future significant architectural decisions should be documented as ADRs.
1 parent e3a99c1 commit baf1a2c

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.adr-dir

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/architecture-decisions
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 1. Record architecture decisions
2+
3+
Date: 2024-01-22
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)