This directory contains Architecture Decision Records (ADRs) for OSM Notes API.
Architecture Decision Records are documents that capture important architectural decisions made during the project. They help:
- Track why decisions were made
- Understand the context and alternatives considered
- Share knowledge with the team
- Avoid revisiting the same decisions
Each ADR follows this structure:
- Status: Proposed | Accepted | Rejected | Deprecated | Superseded
- Context: The issue motivating the decision
- Decision: The decision made
- Consequences: Positive and negative impacts
- Alternatives Considered: Other options that were evaluated
- ADR-0001: Record Architecture Decisions
- ADR-0002: Use Node.js + Express
- ADR-0003: Use Redis for Cache
- ADR-0004: Hybrid OAuth Approach
- ADR-0005: Restrictive Rate Limiting
- Copy Template.md to a new file:
000X-short-title.md - Fill in the template
- Update this README with the new ADR
- Commit with message:
docs(adr): add ADR-000X for [decision]