Docs: Improve backend local setup guide and add first-time contributor checklist#43
Open
adititiwari0810 wants to merge 1 commit intoPSMRI:mainfrom
Open
Conversation
📝 WalkthroughWalkthroughThe documentation file for development environment setup has been replaced with a comprehensive "First-Time Backend Contributor Guide" tailored for Windows and IntelliJ users. The update includes new sections on repository selection, Java version configuration, Maven build output, database schema, Git workflow, and a backend setup checklist. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
developer-guide/development-environment-setup.md (2)
19-20: Replace “Suggestion”/future-tense phrasing with direct guidance.This guide is already presenting the recommended process, but Lines 19, 67, 114, and 135+ still read like proposal text (“Suggestion”, “These additions would…”). Converting those to direct, present-tense instructions will make the document feel final and authoritative.
Also applies to: 67-68, 114-115, 135-141
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@developer-guide/development-environment-setup.md` around lines 19 - 20, Update the phrasing in developer-guide/development-environment-setup.md by replacing tentative language such as the header "Suggestion" and phrases like "These additions would…" with direct, present-tense/instructional wording; specifically edit the occurrences around the sections referenced (lines ~19, ~67-68, ~114-115, and ~135-141) so they read as authoritative commands or statements (e.g., change "Suggestion:" to "Guidance:" or remove the label and reword sentences to imperative/present tense) and ensure consistency across the document.
28-29: Use fenced code blocks for commands and terminal output.These snippets are currently plain text, which hurts readability and copy/paste reliability. Wrap them in Markdown code fences (for example,
bash for commands andtext for output).Suggested doc formatting pattern
- mvvn clean install +```bash +mvn clean install +``` -BUILD SUCCESS -Tests run: 1778, Failures: 43 +```text +BUILD SUCCESS +Tests run: 1778, Failures: 43 +```Also applies to: 48-49, 54-56, 95-96, 106-107, 110-111
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@developer-guide/development-environment-setup.md` around lines 28 - 29, Several command and terminal output snippets in the "Project JDK is not defined" section are plain text; wrap each command in fenced code blocks using language hints (e.g., use ```bash for commands like "mvn clean install") and wrap corresponding output in ```text blocks (e.g., "BUILD SUCCESS\nTests run: 1778, Failures: 43"). Locate the exact occurrences of the commands and outputs (such as the "mvn clean install" command and the "BUILD SUCCESS" output) and replace the inline/plain text with the fenced-code format; apply the same change to the other instances called out (the snippets around the other listed ranges) to ensure consistent formatting and copy/paste reliability.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@developer-guide/development-environment-setup.md`:
- Around line 54-66: The example showing "BUILD SUCCESS" alongside test failures
is misleading; update the documentation text near the Maven example that
includes the literal output "BUILD SUCCESS" and "Tests run:" to state that this
only occurs when tests are skipped or test failures are ignored, and explicitly
show or mention the Maven flags that cause this behavior (e.g., -DskipTests,
-DskipITs, or -Dmaven.test.failure.ignore=true) and that by default Maven will
report BUILD FAILURE on test failures unless those settings are used; adjust the
wording to instruct readers to verify whether those flags are present before
assuming a successful build.
---
Nitpick comments:
In `@developer-guide/development-environment-setup.md`:
- Around line 19-20: Update the phrasing in
developer-guide/development-environment-setup.md by replacing tentative language
such as the header "Suggestion" and phrases like "These additions would…" with
direct, present-tense/instructional wording; specifically edit the occurrences
around the sections referenced (lines ~19, ~67-68, ~114-115, and ~135-141) so
they read as authoritative commands or statements (e.g., change "Suggestion:" to
"Guidance:" or remove the label and reword sentences to imperative/present
tense) and ensure consistency across the document.
- Around line 28-29: Several command and terminal output snippets in the
"Project JDK is not defined" section are plain text; wrap each command in fenced
code blocks using language hints (e.g., use ```bash for commands like "mvn clean
install") and wrap corresponding output in ```text blocks (e.g., "BUILD
SUCCESS\nTests run: 1778, Failures: 43"). Locate the exact occurrences of the
commands and outputs (such as the "mvn clean install" command and the "BUILD
SUCCESS" output) and replace the inline/plain text with the fenced-code format;
apply the same change to the other instances called out (the snippets around the
other listed ranges) to ensure consistent formatting and copy/paste reliability.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
.gitbook/assets/VL1DJy904BtlhvXm1I_64ua6a21Dm12iDnCpxOvqmtQtxcxvYE6_EuijiPZOIsSdx-FD6_c0BjIb5XN_LQugD05witcoXl4gwG5wY0yXCM26dc1fpSR6zNJIvSoJ5RoGswcS8gsTkw3nPBg49moqnoCyejOPvji8lpo4E9lVFB01324ndbm0GtjOABDTqsTDFhoPBt0_Oo87W5c1ptMPaHi07nHgVn_ibao39eRaZf27SO2JQAtOf4t9Jcl.pngis excluded by!**/*.png.gitbook/assets/VLB1RXCn4BtxAvvw0jf2AswLKhMaAOdKqcgJgfTSfhl3refZB_OiRLHLoeaFG1pXoeVbIx2Nx4P1WAMrrZFlZTyypqaGybBFZQ9SdCVD21ImS-wT5RO5NWnl-p7uSaTL4QTpNP6Lc1-ECfnUZtOIEXrKGK9t51YNpfOkXS_UAHNBxH-ZGH_X-ceymPkIBNiIlj1sDd4pjbEx-l8LdZ_L76HKg8IEhCYFd94Dx0LFNNeFGKZgq9F4pNw7EOO.pngis excluded by!**/*.png.gitbook/assets/VLFFJXjF3BxlKrWSVlfL3GhboA42aW9HKuX8K2zSd5sJZkATsSvuKbOL5QS-GDLBfVRbU99wPqF-H2eZ8NRip_u-VvuS1q4liUGCSt4URW9vm01xVPVkJzz_m0Z5a1Mu6UnbbQ9DRYhK-zx5nruJLBp-sqwTNGokuMGqW27Mv1Ea2UtK3qOm9hymEIN4ydiRT7BQ_m3dAFG5wuHg0bcMXEw_LM8uWbPizrceU3ERaG-tzkdnzz3OEUJeQJz.pngis excluded by!**/*.png.gitbook/assets/XT8nJ_im40NmtP_Ynlz_GEmPK1D2QOGgLIbbhKxE0uA2RUmBADyU4pb5faACFl_ytWrU1M4lu-kWM8lrj6FfOIITRbdmmPDoqVIwTso4octRt1ytpI6RRfhTiJoRL4gTE5rSBNa5NLiJ456Bjn51LBg8PjcWeD8vRzznsU85MbIQPp69X9INvPoAlzjABtXaBVbIy-e5hI7wcMeMfd_BWwR-Vswht-qSzQFyncW_EK57rMYw0JEg_a9Pwm.pngis excluded by!**/*.png.gitbook/assets/ZLPDZzis4BthLyofiD4MHTkRW6tZjREnq3hh-YEd008Zpbh4ogGw7DbLVdr9MemjEt9oMAoeUVCnxys8VcDP43VxAX456uAbO8MQkzFaSRR8tmd6esX1MEWUazhvg4BLGZDC5gjiuutX8L-tbd7VGyopfRUxVr-tRa_MRRHAmUAJi0XBOtb7QCzl5aRlJ5AOgiA2bT4MLYYLxRtv89gAa-JX0HQgGij68poxlz7Yrt7gMffFO4eeF1X-WB.pngis excluded by!**/*.png
📒 Files selected for processing (1)
developer-guide/development-environment-setup.md
Comment on lines
+54
to
+66
| BUILD SUCCESS | ||
| Tests run: 1778, Failures: 43 | ||
|
|
||
|
|
||
| This can be confusing. | ||
|
|
||
| Clarification: | ||
|
|
||
| - `BUILD SUCCESS` means the project compiled successfully. | ||
| - Test failures may still be present. | ||
| - For documentation-only or small changes, failing legacy tests may not always block progress. | ||
| - Always verify whether test failures are related to your changes before proceeding. | ||
|
|
There was a problem hiding this comment.
Correct the Maven example: BUILD SUCCESS with test failures is conditional.
On Line 54–56, the example implies failed tests can coexist with a normal successful build by default. In standard Maven flow, test failures usually produce BUILD FAILURE unless failure-ignore/skipping is configured. Please clarify that this outcome only occurs with specific settings (e.g., tests skipped or failures ignored).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@developer-guide/development-environment-setup.md` around lines 54 - 66, The
example showing "BUILD SUCCESS" alongside test failures is misleading; update
the documentation text near the Maven example that includes the literal output
"BUILD SUCCESS" and "Tests run:" to state that this only occurs when tests are
skipped or test failures are ignored, and explicitly show or mention the Maven
flags that cause this behavior (e.g., -DskipTests, -DskipITs, or
-Dmaven.test.failure.ignore=true) and that by default Maven will report BUILD
FAILURE on test failures unless those settings are used; adjust the wording to
instruct readers to verify whether those flags are present before assuming a
successful build.
drtechie
reviewed
Apr 20, 2026
Member
There was a problem hiding this comment.
this is a parent page in gitbook that shows other children pages.
https://piramal-swasthya.gitbook.io/amrit/developer-guide/development-environment-setup
we already other pages under this parent with similar documentation.
Do you mind tweaking them instead?
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.
Improves clarity for first-time backend contributors setting up AMRIT locally (Windows + IntelliJ).
Adds:
Based on real onboarding experience to reduce setup friction.
Related to #111
Summary by CodeRabbit