18 lines
510 B
Markdown
18 lines
510 B
Markdown
# Architectural Decision Records (ADR)
|
|
|
|
This is a repo of key architecture decisions for Jan. [Read more about ADRs](https://github.com/joelparkerhenderson/architecture-decision-record)
|
|
|
|
|
|
### Get started:
|
|
|
|
```sh
|
|
# In root:
|
|
make newadr
|
|
```
|
|
|
|
### Template:
|
|
- **Status**: `pending`, `approved`, or `rejected`
|
|
- **Context**: a clearly defined problem/goal
|
|
- **Decisions**: the proposed architecture choices & changes
|
|
- **Consequences**: pros and cons of the decision
|
|
- **References**: any relevant materials to read |