Architectural Decision Records
Read this when you want the reasoning behind a past design choice or need to record a new one.
What are these?
These are short documents providing context around architectural and design choices made in the process of building this project. They are supposed to be short and don't need to be perfect. That way we can keep the bar towards writing an ADR low and document larger changes in the project.
ref. https://github.com/joelparkerhenderson/architecture-decision-record
Index
- 001 - Leaderboard Improvements
- 002 - Define API contracts through OpenAPI
- 003 - Zod as a request parser
- 004 - Automating contest scheduling
- 005 - Scoring rules and metadata ownership
Template
# [id] Title
- Status: [proposed | rejected | accepted | deprecated | ... | superseded by ADR-002]
- Author: @githubhandle
- Date: YYYY-MM-DD
## Context
## Considered options
## Decision
## Outcome