FiveGuesses · v0.1.0
0001. Record architecture decisions
- Status: accepted
- Date: 2026-10-06
Context
Decisions about this project (tools, structure, interfaces, trade-offs) need to stay understandable for reviewers, contributors and the maintainer months later, without reading the whole history.
Considered options
- Architecture Decision Records in the repository, one Markdown file per decision.
- A wiki page.
- Decisions only in issues and pull requests.
Decision
Chosen option: ADRs in docs/adr/, in the MADR-lite format of
0000-template.md, because they are versioned with the code, reviewed in the
same pull requests and published with the documentation.
Consequences
- Good: every significant decision has a short, dated record with the options that were rejected.
- Good: the README’s “Design decisions” section links the important ones.
- Bad: writing an ADR takes about 10 minutes; small, reversible choices do not need one.
Not affiliated with or endorsed by Apple. Apple Music and the iTunes Search API are named only to describe where the song previews come from.
docs/adr/0001-record-architecture-decisions.md on GitHub
Licensed under MIT. Source: luminare-dev/FiveGuesses at v0.1.0.