formatting
This commit is contained in:
parent
02ccc88d24
commit
c46729f365
1 changed files with 18 additions and 0 deletions
|
|
@ -6,6 +6,7 @@ decision between options was made.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Format A — ADR (architectural/infrastructural decisions)
|
## Format A — ADR (architectural/infrastructural decisions)
|
||||||
|
|
||||||
Use when: you chose between options with long-term consequences.
|
Use when: you chose between options with long-term consequences.
|
||||||
Prefix: `adr-`
|
Prefix: `adr-`
|
||||||
|
|
||||||
|
|
@ -14,45 +15,56 @@ Prefix: `adr-`
|
||||||
# ADR: <title>
|
# ADR: <title>
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
Accepted | Superseded by | Deprecated
|
Accepted | Superseded by | Deprecated
|
||||||
|
|
||||||
## Date
|
## Date
|
||||||
|
|
||||||
YYYY-MM-DD
|
YYYY-MM-DD
|
||||||
|
|
||||||
## Context
|
## Context
|
||||||
|
|
||||||
What is the problem? Why does it need to be solved?
|
What is the problem? Why does it need to be solved?
|
||||||
|
|
||||||
## Decision
|
## Decision
|
||||||
|
|
||||||
What was chosen and why in one or two sentences.
|
What was chosen and why in one or two sentences.
|
||||||
|
|
||||||
## Options considered
|
## Options considered
|
||||||
|
|
||||||
### Option A — <name> ✅
|
### Option A — <name> ✅
|
||||||
|
|
||||||
Description. Why it was chosen.
|
Description. Why it was chosen.
|
||||||
|
|
||||||
### Option B — <name>
|
### Option B — <name>
|
||||||
|
|
||||||
Description. Why it was rejected.
|
Description. Why it was rejected.
|
||||||
|
|
||||||
## Consequences
|
## Consequences
|
||||||
|
|
||||||
- What gets better
|
- What gets better
|
||||||
- What gets worse or more complex
|
- What gets worse or more complex
|
||||||
- Operational implications
|
- Operational implications
|
||||||
- What breaks if this needs to be redone
|
- What breaks if this needs to be redone
|
||||||
|
|
||||||
## Affected files / machines
|
## Affected files / machines
|
||||||
|
|
||||||
- List files, servers, or systems touched
|
- List files, servers, or systems touched
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- Links to relevant docs
|
- Links to relevant docs
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Setup guide / implementation notes
|
## Setup guide / implementation notes
|
||||||
|
|
||||||
Step-by-step of what was actually done.
|
Step-by-step of what was actually done.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Format B — Task (features, fixes, chores)
|
## Format B — Task (features, fixes, chores)
|
||||||
|
|
||||||
Use when: routine task with a clear solution.
|
Use when: routine task with a clear solution.
|
||||||
Prefix: `feat-` / `fix-` / `chore-`
|
Prefix: `feat-` / `fix-` / `chore-`
|
||||||
|
|
||||||
|
|
@ -61,17 +73,23 @@ Prefix: `feat-` / `fix-` / `chore-`
|
||||||
# <prefix>: <title>
|
# <prefix>: <title>
|
||||||
|
|
||||||
## Problem
|
## Problem
|
||||||
|
|
||||||
What was wrong or missing?
|
What was wrong or missing?
|
||||||
|
|
||||||
## Options considered
|
## Options considered
|
||||||
|
|
||||||
### Option A — <name> ✅
|
### Option A — <name> ✅
|
||||||
|
|
||||||
### Option B — <name>
|
### Option B — <name>
|
||||||
|
|
||||||
## Solution
|
## Solution
|
||||||
|
|
||||||
What was done and why.
|
What was done and why.
|
||||||
|
|
||||||
## Files changed
|
## Files changed
|
||||||
|
|
||||||
- `path/to/file.ts`
|
- `path/to/file.ts`
|
||||||
|
|
||||||
## Commit
|
## Commit
|
||||||
|
|
||||||
`<type>: <message>`
|
`<type>: <message>`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue