FINERACT-2644: Add event-driven modularization design doc (FSIP-12)#6031
Open
mansi75 wants to merge 3 commits into
Open
FINERACT-2644: Add event-driven modularization design doc (FSIP-12)#6031mansi75 wants to merge 3 commits into
mansi75 wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new AsciiDoc design document describing a proposed event-driven approach to enforcing module boundaries between Fineract feature areas (via fineract-core read contracts and fineract-command write contracts).
Changes:
- Add a new design document:
Event-driven architecture for modular design.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… of documentation build
…patibility Signed-off-by: mansimaurya <mansimaurya75@gmail.com>
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
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.
Description
This PR adds a new design document,
Event-driven architecture for modular design, to the Fineract documentation (fineract-doc).The document describes the proposed approach for getting Fineract's module boundaries under control. Today, feature modules import each other's internal classes directly (e.g. loan reads savings entities, savings calls accounting services, accounting depends on organisation repositories), and nothing enforces the use of the existing
fineract-coreandfineract-commandshared modules. The doc proposes making those two modules the only permitted cross-feature dependency — reads cross a boundary as afineract-coreinterface returning a DTO, writes cross as afineract-commandcommand or domain event — and migrating all direct feature-to-feature imports to that model in phased, risk-ordered steps, with an ArchUnit rule activated in CI once the violation count reaches zero.Changes in this PR:
fineract-doc/src/docs/en/modularization.adoc(the design document).fineract-doc/src/docs/en/index.adocvia aninclude::directive so it renders in the documentation build.This is a documentation-only change. There are no code, REST API, schema, or behavioural changes.
Related JIRA: https://issues.apache.org/jira/browse/FINERACT-2644
Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
./gradlew :fineract-doc:doc(docs build green).Your assigned reviewer(s) will follow our guidelines for code reviews.