Architecture Decision Records (ADRs)¶

This directory contains Architecture Decision Records (ADRs) for the Fetch ML project.

What are ADRs?¶

Architecture Decision Records are short text files that document a single architectural decision. They capture the context, options considered, decision made, and consequences of that decision.

ADR Template¶

Each ADR follows this structure:

# ADR-XXX: [Title]

## Status
[Proposed | Accepted | Deprecated | Superseded]

## Context
[What is the issue that we're facing that needs a decision?]

## Decision
[What is the change that we're proposing and/or doing?]

## Consequences
[What becomes easier or more difficult to do because of this change?]

## Options Considered
[What other approaches did we consider and why did we reject them?]

ADR Index¶

ADR	Title	Status
ADR-001	Use Go for API Server	Accepted
ADR-002	Use SQLite for Local Development	Accepted
ADR-003	Use Redis for Job Queue	Accepted

How to Add a New ADR¶

Create a new file named ADR-XXX-title.md where XXX is the next sequential number
Use the template above
Update this README with the new ADR in the index
Submit a pull request for review

ADR Lifecycle¶

Proposed: Initial draft, under discussion
Accepted: Decision made and implemented
Deprecated: Decision no longer recommended but still in use
Superseded: Replaced by a newer ADR