Skip to content

Commit 9b9fdff

Browse files
Merge pull request #290 from mxenabled/wes/baseADR
docs: added a base Architecture Decision Record
2 parents 0d76e32 + 1388050 commit 9b9fdff

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

architectureDecisionRecords/0000Example.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Title of the ADR
44

5+
## Date proposed
6+
7+
01-01-0001
8+
59
## Context
610

711
What is the issue that we're seeing that is motivating this decision or change?

architectureDecisionRecords/0001Styling.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Styling our html
44

5+
## Date proposed
6+
7+
08-19-2025
8+
59
## Context
610

711
According to the [state of css 2025](https://2025.stateofcss.com/en-US) the tools that people are the most happy with in 2025 are [css modules](https://github.com/css-modules/css-modules) and [tailwindcss](https://tailwindcss.com/).
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Title
2+
3+
Document architecture decisions
4+
5+
## Date proposed
6+
7+
02-12-2026
8+
9+
## Context
10+
11+
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.
12+
13+
## Decision
14+
15+
We will document our decisions in our repositories as architecture decision records.
16+
17+
We will follow the template provided in 0000Example.md.
18+
19+
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.
20+
21+
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.
22+
23+
When making changes to code that doesn't conform to the ADRs the following steps should be taken:
24+
25+
1. If feasible update the code to conform to the ADRs
26+
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
27+
28+
## Consequences
29+
30+
Engineers will be able to go to a single place to learn the following
31+
32+
1. What architecture decisions were made and why
33+
1. What libraries should be used
34+
1. What coding patterns and style should be used
35+
1. What expectations will need to be met before a PR can be merged
36+
37+
Pull requests will need conform to the ADRs to be approved.

0 commit comments

Comments
 (0)