1d73209e89
* docs: add Architecture Decision Records (ADRs) Established a system for documenting architectural decisions. - Created docs/adr directory - Added ADR template (0000-template.md) - Established ADR process in docs/adr/README.md - Documented 4 key existing decisions (0001-0004) - Integrated ADRs into mkdocs.yml and docs/index.md * docs: add Architecture Decision Records (ADRs) Established a system for documenting architectural decisions. - Created docs/adr directory - Added ADR template (0000-template.md) - Established ADR process in docs/adr/README.md - Documented 4 key existing decisions (0001-0004) - Integrated ADRs into mkdocs.yml and docs/index.md - Fixed formatting in pkg/io/local/client.go * docs: add ADRs and fix auto-merge CI - Added Architecture Decision Records (ADRs) to docs/adr/ - Integrated ADRs into mkdocs.yml and docs/index.md - Localized .github/workflows/auto-merge.yml to fix "fatal: not a git repository" error in the reusable workflow by adding explicit --repo context.
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# ADR Template
|
|
|
|
* Status: [proposed | rejected | accepted | deprecated | superseded by [ADR-NNNN](NNNN-example.md)]
|
|
* Deciders: [list of names or roles involved in the decision]
|
|
* Date: [YYYY-MM-DD when the decision was last updated]
|
|
|
|
## Context and Problem Statement
|
|
|
|
[Describe the context and problem statement, e.g., in free form using several paragraphs or bullet points. Explain why this decision is needed now.]
|
|
|
|
## Decision Drivers
|
|
|
|
* [driver 1, e.g., a force, facing concern, ...]
|
|
* [driver 2, e.g., a force, facing concern, ...]
|
|
|
|
## Considered Options
|
|
|
|
* [option 1]
|
|
* [option 2]
|
|
|
|
## Decision Outcome
|
|
|
|
Chosen option: "[option 1]", because [justification. e.g., only option, which meets currently debated acceptance criteria].
|
|
|
|
### Positive Consequences
|
|
|
|
* [e.g., improvement in quality attribute, follow-up decisions required, ...]
|
|
* ...
|
|
|
|
### Negative Consequences
|
|
|
|
* [e.g., compromising quality attribute, follow-up decisions required, ...]
|
|
* ...
|
|
|
|
## Pros and Cons of the Options
|
|
|
|
### [option 1]
|
|
|
|
[example | description | pointer to more information | ...]
|
|
|
|
* Good, because [argument 1]
|
|
* Bad, because [argument 2]
|
|
|
|
### [option 2]
|
|
|
|
[example | description | pointer to more information | ...]
|
|
|
|
* Good, because [argument 1]
|
|
* Bad, because [argument 2]
|