Skip to content

FINERACT-2644: Add event-driven modularization design doc (FSIP-12)#6031

Open
mansi75 wants to merge 3 commits into
apache:developfrom
mansi75:FINERACT-2644-modularization-design-doc
Open

FINERACT-2644: Add event-driven modularization design doc (FSIP-12)#6031
mansi75 wants to merge 3 commits into
apache:developfrom
mansi75:FINERACT-2644-modularization-design-doc

Conversation

@mansi75

@mansi75 mansi75 commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

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-core and fineract-command shared modules. The doc proposes making those two modules the only permitted cross-feature dependency — reads cross a boundary as a fineract-core interface returning a DTO, writes cross as a fineract-command command 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:

  • Add fineract-doc/src/docs/en/modularization.adoc (the design document).
  • Register it in fineract-doc/src/docs/en/index.adoc via an include:: 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!

  • Write the commit message as per our guidelines
  • Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
  • Create/update unit or integration tests for verifying the changes made. — N/A: documentation-only change, no code paths to test. Verified locally with ./gradlew :fineract-doc:doc (docs build green).
  • Follow our coding conventions.
  • Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes — N/A: no API changes.
  • This PR must not be a "code dump". Large changes can be made in a branch, with assistance. Ask for help on the developer mailing list.

Your assigned reviewer(s) will follow our guidelines for code reviews.

Copilot AI review requested due to automatic review settings June 24, 2026 13:25

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread fineract-doc/src/docs/en/modularization.adoc
Comment thread fineract-doc/src/docs/en/modularization.adoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants