81b47a200e
* docs: new decision for adding a monitoring tool * docs(adr): fix title * imp(adr): add more consequences * Update docs/decisions/2024-07-12-monitoring-tool.md Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com> --------- Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| 2024-07-12-monitoring-tool.md | ||
| README.md | ||
| template.md | ||
README.md
Decision Log
We capture important decisions with architectural decision records.
These records provide context, trade-offs, and reasoning taken at our community & technical cross-roads. Our goal is to preserve the understanding of the project growth, and capture enough insight to effectively revisit previous decisions.
Get started created a new decision record with the template:
cp template.md YYYY-MM-DD-title-with-dashes.md
For more rational behind this approach, see Michael Nygard's article.
We've inherited MADR ADR template, which is a bit more verbose than Nygard's original template. We may simplify it in the future.
Evolving Decisions
Many decisions build on each other, a driver of iterative change and messiness in software. By laying out the "story arc" of a particular system within the application, we hope future maintainers will be able to identify how to rewind decisions when refactoring the application becomes necessary.