FINERACT-792: Improve developer environment setup documentation #5248
Conversation
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
adamsaghy
reviewed
Dec 18, 2025
CONTRIBUTING.md
Outdated
|
|
||
| ### Prerequisites | ||
| - IntelliJ IDEA (Community Edition is sufficient) | ||
| - Java 17 (as required by Fineract) |
Contributor
There was a problem hiding this comment.
Fineract is on Java 21 already
Contributor
Author
There was a problem hiding this comment.
Thanks for pointing this out.
You’re absolutely right — Fineract is now on Java 21.
I’ll update the prerequisites section accordingly.
adamsaghy
reviewed
Dec 18, 2025
CONTRIBUTING.md
Outdated
| 2. Choose the root `fineract` directory | ||
| 3. When prompted, import the project as a **Gradle project** | ||
| 4. Use the Gradle wrapper (`gradlew`) when asked | ||
| 5. Ensure the correct JDK is selected (**Java 17**) |
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.
###Description
This pull request improves the developer environment setup documentation by adding clear guidance on recommended IDEs and updating the steps to run and debug Apache Fineract using Eclipse and IntelliJ IDEA.
The goal is to reduce onboarding friction for new contributors and provide up-to-date, structured IDE setup instructions in a single, easily discoverable place.
Changes Included
Added a Recommended IDEs section for new contributors
Structured and clarified Eclipse IDE run and debug instructions
Added IntelliJ IDEA run and debug setup steps aligned with the current Gradle-based build
Improved readability and consistency of the development setup documentation
###Testing
Documentation-only change.
No build, runtime, or test execution required.
###JIRA Reference
https://issues.apache.org/jira/browse/FINERACT-792
Checklist