Revise ECD module installation steps in README#78
Conversation
Updated installation instructions for the ECD module to include cloning the Common-ui repository and adjusted the step numbers accordingly.
📝 WalkthroughWalkthroughThe README.md installation instructions are updated to add a prerequisite step: cloning the Common-ui repository and checking out the release-3.6.1-ECD branch before running npm install, build, and start commands. This clarifies the dependency setup sequence. ChangesInstallation Instructions Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 45-46: Summary: Steps 2–3 in README.md are ambiguous and lack
exact commands, repo URL, and target directory. Fix: replace the vague lines
"Clone the Common-ui repository, switch branch to release-3.6.1-ECD." and
"Install the dependencies and build the module:" with explicit shell commands
and sequencing that show the exact git clone URL
(https://github.com/PSMRI/Common-ui.git), cd into the cloned directory
(Common-ui), checkout the branch release-3.6.1-ECD, then return to the parent
directory if needed; also add the concrete install/build commands to run there
(e.g., install and build steps) and mention the working directory expectations
so the Common-ui prerequisite is an executable set of steps rather than a
descriptive note. Reference: the README.md lines describing Common-ui
clone/branch and the branch name release-3.6.1-ECD.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| 2. Clone the Common-ui repository, switch branch to release-3.6.1-ECD. | ||
| 3. Install the dependencies and build the module: |
There was a problem hiding this comment.
Make the Common-ui prerequisite executable, not descriptive.
These steps are currently ambiguous (no repo URL, no exact commands, no target directory). New setup attempts can fail or diverge.
📌 Proposed doc fix
-2. Clone the Common-ui repository, switch branch to release-3.6.1-ECD.
+2. Clone `Common-ui` and check out the required branch:
+ ```bash
+ git clone https://github.com/PSMRI/Common-ui.git
+ cd Common-ui
+ git checkout release-3.6.1-ECD
+ cd ..
+ ```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 2. Clone the Common-ui repository, switch branch to release-3.6.1-ECD. | |
| 3. Install the dependencies and build the module: | |
| 2. Clone `Common-ui` and check out the required branch: |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 45 - 46, Summary: Steps 2–3 in README.md are
ambiguous and lack exact commands, repo URL, and target directory. Fix: replace
the vague lines "Clone the Common-ui repository, switch branch to
release-3.6.1-ECD." and "Install the dependencies and build the module:" with
explicit shell commands and sequencing that show the exact git clone URL
(https://github.com/PSMRI/Common-ui.git), cd into the cloned directory
(Common-ui), checkout the branch release-3.6.1-ECD, then return to the parent
directory if needed; also add the concrete install/build commands to run there
(e.g., install and build steps) and mention the working directory expectations
so the Common-ui prerequisite is an executable set of steps rather than a
descriptive note. Reference: the README.md lines describing Common-ui
clone/branch and the branch name release-3.6.1-ECD.
3 participants
Updated installation instructions for the ECD module to include cloning the Common-ui repository and adjusted the step numbers accordingly.
📋 Description
JIRA ID:
Please provide a summary of the change and the motivation behind it. Include relevant context and details.
✅ Type of Change
ℹ️ Additional Information
Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.
Summary by CodeRabbit
Common-uirepository and checking out therelease-3.6.1-ECDbranch as a prerequisite before installing the ECD module.