spring-projects / spring-projects/spring-modulith
Generate Aggregate Diagrams
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.2k
- Forks
- 222
- PR merge metrics
- No merged PRs in 30d
Description
As an architecturally curious developer, I would like to have diagrams for the DDD tactical patterns applied to our modules using jMolecules, so I can more easily understand the DDD relationships.
Acceptance Criteria:
The documentation generates:
- a diagram that shows all associations between aggregates per module
- for each aggregate a diagram of its root, entities and value objects.
Background:
In our project we often get requests by team members or interested parties to produce a diagram of aggregates and their relationships.
If I am not mistaken, Spring Modulith doesn't do this yet (admittedly, we are not on 7.x due to some migration issues).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the existing documentation-generation facilities and how jMolecules represents DDD tactical patterns; done means generated documentation includes module-wide aggregate associations and per-aggregate diagrams of roots, entities, and value objects.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100