Architecture Decision Records
View SourceThis directory contains Architecture Decision Records (ADRs) for DeepEvalEx.
What is an ADR?
An ADR is a document that captures an important architectural decision made along with its context and consequences. ADRs help teams understand why certain decisions were made and provide historical context for future maintainers.
ADR Index
| ID | Title | Status | Date |
|---|---|---|---|
| ADR-0001 | Behaviour-Based Plugin Architecture | Accepted | 2024-12-25 |
| ADR-0002 | Ecto Embedded Schemas Without Database | Accepted | 2024-12-25 |
| ADR-0003 | Telemetry-First Observability | Accepted | 2024-12-25 |
| ADR-0004 | Concurrent Evaluation with Task.async_stream | Accepted | 2024-12-25 |
| ADR-0005 | Multi-Step Prompting for RAG Metrics | Accepted | 2024-12-25 |
| ADR-0006 | JSON Schema Mode for Structured LLM Outputs | Accepted | 2024-12-25 |
| ADR-0007 | BaseMetric Macro for Automatic Instrumentation | Accepted | 2024-12-25 |
ADR Template
New ADRs should follow the template in template.md.
Statuses
- Proposed - Under discussion
- Accepted - Approved and implemented
- Deprecated - No longer valid, superseded by another ADR
- Superseded - Replaced by a newer ADR (link to replacement)
Contributing
When making significant architectural decisions:
- Copy
template.mdto a new file with the next sequential number - Fill in all sections
- Submit for review
- Update the index once accepted