Skip to content

Commit 49bf8a3

Browse files
committed
Change wording for ADRs and add template
1 parent c52aaa1 commit 49bf8a3

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed
Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
% This Source Code Form is subject to the terms of the Mozilla Public
2-
3-
% License, v. 2.0. If a copy of the MPL was not distributed with this
4-
5-
% file, You can obtain one at http://mozilla.org/MPL/2.0/.
6-
71
# Architectural Decision Records
82

9-
We record major architectural decisions in Architecture Decision Records (ADRs),
10-
as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
11-
Below is the list of our current ADRs.
3+
Architectural decisions are made throughout a project's lifetime. As a way of keeping track of these decisions, we record these decisions in Architecture Decision Records (ADRs) listed below.
124

135
```{toctree}
146
:glob: true
157
:maxdepth: 1
168
179
decisions/*
1810
```
11+
12+
For more information on ADRs see this [blog by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 3. Short descriptive title
2+
3+
Date: Today's date
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
Background to allow us to make the decision, to show how we arrived at our conclusions.
12+
13+
## Decision
14+
15+
What decision we made.
16+
17+
## Consequences
18+
19+
What we will do as a result of this decision.

0 commit comments

Comments
 (0)