Skip to content

Commit f226002

Browse files
committed
add adr pr
1 parent 1e45c74 commit f226002

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: ADR Template
3+
description: Template for Express Architecture Decision Records
4+
labels: ADR
5+
---
6+
7+
# ADR template
8+
9+
This is the base template that we use
10+
11+
# ADR [Number]: [Title of Decision]
12+
13+
## Status
14+
[Proposed | Accepted | Deprecated | Superseded by ADR [number]]
15+
16+
## Submitters
17+
[List of people who proposed this decision. Include GitHub usernames or names with contact information if needed.]
18+
- @username1
19+
- @username2
20+
21+
## Decision Owners
22+
[List of people responsible for driving the decision and following up on its implementation. This may include teams or subject matter experts.]
23+
- @owner1
24+
- @team1
25+
26+
## Context
27+
Describe the problem, need, or feature request that prompted this decision. Include any relevant background information, constraints, and considerations that were taken into account.
28+
29+
- **Why do we need this decision?**
30+
- **What problem does it solve or avoid?**
31+
- **Are there any existing issues/discussions/pull requests related to this?** (Include links to relevant GitHub issues, forum threads, or discussion channels.)
32+
33+
## Decision
34+
Clearly state the decision that was made. Describe the chosen solution or approach in detail so that others can understand what was decided.
35+
36+
- **What will be done?**
37+
- **What will not be done?** (If applicable, specify what was explicitly ruled out.)
38+
39+
## Rationale
40+
Explain why this decision was made, including a discussion of the alternatives considered and why they were not chosen.
41+
42+
- **Alternatives Considered:**
43+
- Alternative 1: [Description and reasons for rejection]
44+
- Alternative 2: [Description and reasons for rejection]
45+
- **Pros and Cons**: Outline the pros and cons of the chosen solution.
46+
- **Why is this decision the best option?** (Explain the key factors that influenced this choice.)
47+
48+
## Consequences
49+
Describe the positive and negative outcomes of the decision, including any potential risks or technical debt.
50+
51+
- **Positive Impact**: What benefits does this decision bring to the project?
52+
- **Negative Impact**: What challenges or limitations does this introduce?
53+
- **Mitigations**: How will we address potential drawbacks or issues?
54+
55+
## Implementation
56+
(Optional, if relevant)
57+
Outline the steps required to implement the decision. This section is particularly useful if the decision involves a series of actions or a roadmap.
58+
59+
- **Phase 1**: [Description]
60+
- **Phase 2**: [Description]
61+
- **Estimated Effort**: Provide a rough estimate of time or effort needed.
62+
63+
## References
64+
Include any external links, documents, discussions, or research that were referenced during the decision-making process.
65+
66+
- [Link to relevant GitHub issue or pull request](#)
67+
- [Link to forum discussion](#)
68+
- [Documentation or research sources](#)
69+
70+
71+
## Changelog
72+
Track changes or updates to this ADR over time. Include the date, author, and a brief description of each change.
73+
74+
- **[YYYY-MM-DD]**: [@username] - [Brief description of the change]
75+
- Example: **[2024-10-22]**: @owner1 - Updated the decision to include support for Redis caching.
76+
- **[YYYY-MM-DD]**: [@username] - [Brief description of the change]
77+
- Example: **[2025-01-15]**: @username2 - Deprecated this ADR due to a shift in the database strategy.

0 commit comments

Comments
 (0)