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