This directory contains Architecture Decision Records (ADRs) for the EasyScience corelib project.
An Architecture Decision Record (ADR) is a document that captures an important architectural decision made along with its context and consequences. ADRs help teams:
- Understand why certain design decisions were made
- Onboard new team members
- Evaluate whether past decisions still make sense
- Avoid repeating discussions about already-decided issues
Each ADR follows this structure:
- Title: ADR number and descriptive title
- Status: Proposed, Accepted, Deprecated, or Superseded
- Context: What is the issue that we're seeing that is motivating this decision or change?
- 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?
- Alternatives Considered: What other options were evaluated?
- Implementation Details: Technical details of the implementation
- References: Links to related issues, PRs, or documentation
- Decision Date: When this decision was made
- Proposed: Initial draft, under discussion
- Accepted: Decision has been approved and implemented
- Deprecated: No longer relevant but kept for historical reference
- Superseded: Replaced by a newer ADR (link to the new one)
- ADR-0001 - ModelCollection for List-Based Model Management (Proposed)
When creating a new ADR:
- Use the next available number (e.g.,
0002-descriptive-title.md) - Start with status "Proposed"
- Include all relevant context and technical details
- Link to related issues or pull requests
- Update this README with the new ADR