Back to Feast

Architecture Decision Records (ADR)

docs/adr/README.md

0.63.02.4 KB
Original Source

Architecture Decision Records (ADR)

This directory contains Architecture Decision Records (ADRs) for the Feast project. ADRs document significant architectural decisions made during the development of Feast, providing context, rationale, and consequences for each decision.

What is an ADR?

An Architecture Decision Record captures a single architectural decision, including the context in which it was made, the decision itself, and the expected consequences. ADRs serve as a historical record for current and future contributors to understand why the project is structured the way it is.

ADR Index

ADRTitleStatusOriginal RFC
ADR-0001Feature ServicesAcceptedRFC-015
ADR-0002Component RefactorAcceptedRFC-020
ADR-0003On-Demand TransformationsAcceptedRFC-021
ADR-0004Entity Join Key MappingAcceptedRFC-023
ADR-0005Stream TransformationsAcceptedRFC-036
ADR-0006Kubernetes OperatorAcceptedRFC-042
ADR-0007Unified Feature Transformations and Feature ViewsAcceptedRFC-043
ADR-0008Feature View VersioningAcceptedFeature View Versioning RFC
ADR-0009Contribution and Extensibility ArchitectureAcceptedRFC-014
ADR-0010Vector Database Integration for LLM/RAG SupportAcceptedRFC-040
ADR-0011Data Quality MonitoringAcceptedRFC-027

Creating a New ADR

  1. Copy the ADR template to a new file with the next sequential number.
  2. Fill in all sections of the template.
  3. Submit a pull request with the new ADR.
  4. Once the RFC is finalized and approved, update the ADR status to "Accepted".

ADR Statuses

  • Proposed: The decision is under discussion.
  • Accepted: The decision has been accepted and is being (or has been) implemented.
  • Deprecated: The decision is no longer relevant due to changes in the project.
  • Superseded: The decision has been replaced by a newer ADR.