-
Notifications
You must be signed in to change notification settings - Fork 2
Add Architecture Decision Record (ADR) system #212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
3
commits into
main
Choose a base branch
from
copilot/start-maintaining-adr
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # [NUMBER]. [TITLE] | ||
|
|
||
| Date: [YYYY-MM-DD] | ||
|
|
||
| ## Status | ||
|
|
||
| [Proposed | Accepted | Deprecated | Superseded by [ADR-XXXX](XXXX-title.md)] | ||
|
|
||
| ## 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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # 1. Use Architecture Decision Records | ||
|
|
||
| Date: 2026-01-01 | ||
|
|
||
| ## Status | ||
|
|
||
| Accepted | ||
|
|
||
| ## Context | ||
|
|
||
| As the Rhiza project grows and evolves, we need a systematic way to document important architectural and design decisions. Team members (both current and future) need to understand: | ||
|
|
||
| - Why certain approaches were chosen over alternatives | ||
| - What constraints or requirements influenced past decisions | ||
| - The expected consequences of architectural choices | ||
| - The historical context behind the current system design | ||
|
|
||
| Without such documentation, we risk: | ||
| - Repeating past mistakes or debates | ||
| - Making inconsistent decisions across the project | ||
| - Losing institutional knowledge when team members change | ||
| - Spending time explaining the same decisions repeatedly | ||
|
|
||
| ## Decision | ||
|
|
||
| We will maintain Architecture Decision Records (ADRs) for architecturally significant decisions in the project. | ||
|
|
||
| **Key aspects:** | ||
|
|
||
| 1. **Location**: ADRs will be stored in `docs/adr/` directory | ||
| 2. **Format**: Each ADR will follow the template defined in `0000-adr-template.md` | ||
| 3. **Naming**: Files will be named `XXXX-title-with-hyphens.md` with sequential 4-digit numbering (e.g., `0002-example-decision.md`) | ||
| 4. **Index**: The `docs/adr/README.md` will maintain an index of all ADRs | ||
| 5. **Immutability**: Once accepted, ADRs should not be modified; instead, create new ADRs that supersede old ones | ||
| 6. **Review**: ADRs should be reviewed and discussed before being marked as "Accepted" | ||
|
|
||
| **What qualifies as an ADR-worthy decision:** | ||
|
|
||
| - Changes to the project structure or organization | ||
| - Technology or tool adoption/removal | ||
| - Significant changes to development workflows or processes | ||
| - Design patterns or architectural approaches | ||
| - Changes to build, test, or deployment strategies | ||
|
|
||
| ## Consequences | ||
|
|
||
| ### Positive | ||
|
|
||
| - **Knowledge preservation**: Important decisions and their rationale are documented for future reference | ||
| - **Better onboarding**: New contributors can understand why things work the way they do | ||
| - **Reduced debate**: Past decisions are clearly documented, reducing repetitive discussions | ||
| - **Audit trail**: Clear history of architectural evolution | ||
| - **Better decision-making**: Forces thoughtful consideration of context and consequences | ||
|
|
||
| ### Neutral | ||
|
|
||
| - **Process overhead**: Contributors need to write ADRs for significant decisions (but this is offset by reduced future confusion) | ||
| - **Learning curve**: Team members need to learn when and how to write ADRs | ||
|
|
||
| ### Negative | ||
|
|
||
| - **Initial setup time**: Creating the ADR system and first records requires upfront effort | ||
| - **Maintenance**: The ADR index needs to be kept up-to-date | ||
|
|
||
| Overall, the benefits of maintaining ADRs far outweigh the minimal overhead required to keep them up-to-date. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Architecture Decision Records | ||
|
|
||
| This directory contains Architecture Decision Records (ADRs) for the Rhiza 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 | ||
|
|
||
| Each ADR follows a consistent format defined in [0000-adr-template.md](0000-adr-template.md): | ||
|
|
||
| - **Title and Number**: Sequential numbering with descriptive title | ||
| - **Date**: When the decision was made | ||
| - **Status**: Current state (Proposed, Accepted, Deprecated, Superseded) | ||
| - **Context**: The issue or situation that motivates the decision | ||
| - **Decision**: The change or approach being taken | ||
| - **Consequences**: What becomes easier or harder as a result | ||
|
|
||
| ## ADR Index | ||
|
|
||
| | Number | Title | Status | Date | | ||
| |--------|-------|--------|------| | ||
| | [0001](0001-use-architecture-decision-records.md) | Use Architecture Decision Records | Accepted | 2026-01-01 | | ||
|
|
||
| ## Creating a New ADR | ||
|
|
||
| 1. Copy the template: `cp docs/adr/0000-adr-template.md docs/adr/0002-your-title.md` | ||
| 2. Use the next available 4-digit number (e.g., 0002, 0003, 0004) | ||
| 3. Fill in all sections with relevant information | ||
| 4. Update this README to add your ADR to the index | ||
| 5. Submit via pull request for review | ||
|
|
||
| ## Resources | ||
|
|
||
| - [ADR GitHub Organization](https://adr.github.io/) | ||
| - [Michael Nygard's article on ADRs](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example command shows copying to "0002-your-title.md", but the instruction to "Use the next available 4-digit number" in step 2 already makes this clear. Consider updating the example to use a more realistic title like "0002-example-decision.md" for consistency with the naming pattern shown elsewhere in the documentation.