Architectural Decision Records (ADRs)¶
This directory contains Architectural Decision Records for the aider-lint-fixer project.
What are ADRs?¶
Architectural Decision Records (ADRs) are documents that capture important architectural decisions made along with their context and consequences. They help teams understand why certain decisions were made and provide historical context for future changes.
ADR Format¶
We use the MADR (Markdown Architectural Decision Records) format for consistency and readability.
ADR Lifecycle¶
- Proposed: The ADR is proposed and under discussion
- Accepted: The ADR has been accepted and should be implemented
- Deprecated: The ADR is no longer relevant but kept for historical context
- Superseded: The ADR has been replaced by a newer ADR
Current ADRs¶
| ADR | Title | Status |
|---|---|---|
| 0001 | Record Architecture Decisions | Accepted |
| 0002 | AI Integration Architecture | Accepted |
| 0003 | Modular Plugin System | Accepted |
| 0004 | Hybrid Python-JavaScript Architecture | Accepted |
| 0005 | Python Linter Ecosystem Support | Accepted |
| 0006 | JavaScript/TypeScript Linter Ecosystem Support | Accepted |
| 0007 | Infrastructure/DevOps Linter Ecosystem Support | Accepted |
| 0008 | Deployment Environments and Runtime Requirements | Accepted |
| 0009 | RHEL Container Build Requirements and Subscription Management | Accepted |
Creating New ADRs¶
- Copy the
template.mdfile - Rename it with the next sequential number:
NNNN-title-in-kebab-case.md - Fill in the template with your decision details
- Update this README with the new ADR entry
- Submit for review through the normal PR process
Guidelines¶
- Keep ADRs concise but complete
- Include context, decision, and consequences
- Consider alternatives and trade-offs
- Update status as decisions evolve
- Reference related ADRs when relevant