-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8a0cdde
commit 9747610
Showing
5 changed files
with
50 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Architectural Design Records (ADRs) | ||
|
||
For any architectural/engineering decisions we make, we will create an ADR (Architectural Design Record) to keep track of what decision we made and why. This allows us to refer back to decisions in the future and see if the reasons we made a choice still holds true. This also allows for others to more easily understand the code. ADRs will follow this process: | ||
|
||
- They will live in the repo, under a directory `docs/arch` | ||
- They will be written in markdown | ||
- They will follow the naming convention `adr-NNNN-<decision-title>.md` | ||
- `NNNN` will just be a counter starting at `0001` and will allow us easily keep the records in chronological order. | ||
- The common sections that each ADR should have are: | ||
- Title | ||
- Context | ||
- Options | ||
- Decision | ||
- Consequences | ||
- Use this article as a reference: [https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# { Title } | ||
|
||
## Context | ||
|
||
{ A brief problem statement. Why do we need to make this decision? } | ||
|
||
## Options | ||
|
||
- { Option 1 } | ||
- ... | ||
|
||
### { Option 1 } | ||
|
||
#### Pro's | ||
|
||
- { Pro 1 } | ||
- ... | ||
|
||
#### Con's | ||
|
||
- { Con 1 } | ||
- ... | ||
|
||
## Decision | ||
|
||
#### Selected: { Option x } | ||
|
||
{ Justification } | ||
|
||
## Consequences | ||
|
||
- [+] { Positive consequence } | ||
- [-] { Negative consequence } |