Skip to content

Commit 77300a6

Browse files
docs: added a base Architecture Decision Record
1 parent 2604de3 commit 77300a6

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Title
2+
3+
Document architecture decisions
4+
5+
## Context
6+
7+
It is unclear to engineers what the expectations are for contributing to this repository. We need a system for making, documenting, and enforcing architecture decisions.
8+
9+
## Decision
10+
11+
We will document our decisions in our repositories as architecture decision records.
12+
13+
We will follow the template provided in 0000Example.md.
14+
15+
Decisions will be made by consensus. If an ADR is agreed upon by at least 2/3 of the engineers on the team, then it can be added to the repository.
16+
17+
Pull Requests with new code that doesn't adhere to the ADRs will not be approved. High-priority urgent production bugs are an exception to this rule. This exception should be immediately followed up with a PR to fix the code, so that it conforms with the ADRs.
18+
19+
When making changes to code that doesn't conform to the ADRs the following steps should be taken:
20+
21+
1. If feasible update the code to conform to the ADRs
22+
1. If updating the code to conform to the ADRs is too large of a scope, then at minimum create a ticket to fix the issue later, and write tests the cover the new code
23+
24+
## Consequences
25+
26+
Engineers will be able to go to a single place to learn the following
27+
28+
1. What architecture decisions were made and why
29+
1. What libraries should be used
30+
1. What coding patterns and style should be used
31+
1. What expectations will need to be met before a PR can be merged
32+
33+
Pull requests will need conform to the ADRs to be approved.

0 commit comments

Comments
 (0)