chore(): add adr for the code architecture#22
Open
brandPittCode wants to merge 8 commits intomainfrom
Open
Conversation
brandPittCode
changed the title
etiennej70
requested changes
Apr 14, 2026
|
|
||
| * **Maintainability:** Clear separation between business rules and infrastructure logic. | ||
| * **Testability:** High confidence in core logic through fast, isolated unit tests. | ||
| * **Developer Velocity (Pragmatism):** Reducing boilerplate by allowing Spring Boot 4's dependency injection and transaction management within the domain. |
Collaborator
There was a problem hiding this comment.
please review the decisions drivers : there are your inputs for decision, not based on the decision outcome
|
|
||
| ## Considered Options | ||
|
|
||
| 1. **Pragmatic Hexagonal Architecture (Ports and Adapters with Spring annotations)** |
Collaborator
There was a problem hiding this comment.
Option 3: State-of-the-Art hexagonal architecture ?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR Description
What this PR Provides
This pull request introduces a new Architecture Decision Record (ADR) that documents and justifies the adoption of a "Pragmatic Hexagonal Architecture" for the IDP Core project. The ADR outlines the reasoning, pros and cons, and structural implications of this architectural pattern, aiming to balance maintainability, testability, developer velocity, and open-source friendliness.
Documentation: Code Architecture Pattern
docs/src/contributing/adrs/0002-code-architecture-pattern.md) that:Vale Style Vocabulary Update
.vale/styles/config/vocabularies/IDP/accept.txtlist to include new project-specific terms:Matthieu,Renny,Pluggability, andDTOs, ensuring these are accepted in documentation and ADRs.Fixes
Review
The reviewer must double-check these points:
!after the type/scope to identify the breakingchange in the release note and ensure we will release a major version.
How to test
Breaking changes (if any)
Context of the Breaking Change
Result of the Breaking Change