Source:
ocean/docs/adr/README.md| ✏️ Edit on GitHub
Architecture Decision Records (ADRs)
This directory contains Architecture Decision Records (ADRs) for the Ocean project.
What is an ADR?
An Architecture Decision Record (ADR) is a document that captures an important architectural decision made along with its context and consequences.
ADR Format
We use a lightweight ADR format that includes:
- Title: ADR-XXXX: [descriptive title]
- Date: When the decision was made
- Status: Proposed, Accepted, Deprecated, or Superseded
- Context: The issue motivating this decision
- Decision: The change we're making
- Consequences: Both positive and negative outcomes
- Implementation Details: Optional code examples or diagrams
- Alternatives Considered: Other options that were evaluated
- References: Links to relevant resources
- Decision Makers: People involved in the decision
- Related ADRs: Links to related decisions
Current ADRs
| ADR | Title | Status | Date |
|---|---|---|---|
| 0001 | Adopt TanStack Ecosystem for Forms and Data Fetching | Accepted | 2025-01-26 |
| 0002 | Implement Token-Based Design System for Styling | Accepted | 2025-07-26 |
Creating a New ADR
- Copy the template.md file
- Name it with the next number in sequence:
XXXX-short-description.md - Fill in all sections
- Update this README with the new ADR
- Submit a PR for review
Why ADRs?
- Documentation: Provides context for future developers
- History: Creates a decision log for the project
- Communication: Facilitates discussion about architectural choices
- Onboarding: Helps new team members understand key decisions