Skip to content

docs: fix README setup instructions and Common-UI submodule initialization#349

Open
magic-peach2k5 wants to merge 1 commit into
PSMRI:mainfrom
magic-peach2k5:docs/fix-readme-setup-submodule
Open

docs: fix README setup instructions and Common-UI submodule initialization#349
magic-peach2k5 wants to merge 1 commit into
PSMRI:mainfrom
magic-peach2k5:docs/fix-readme-setup-submodule

Conversation

@magic-peach2k5
Copy link
Copy Markdown

@magic-peach2k5 magic-peach2k5 commented May 13, 2026

Summary

Fixes broken setup instructions in the README and makes it easier for new contributors to get the project running.

Changes

Prerequisites section

  • Changed "Nodejs" to "Node.js" and added nvm usage guidance referencing .nvmrc

Installation section

  • Replaced the flat bullet list with a numbered, concrete step-by-step guide
  • Step 1: Clone with --recurse-submodules (covers the Common-UI submodule from the start), with fallback git submodule update --init --recursive for existing clones
  • Step 2: nvm version management (nvm install && nvm use)
  • Step 3: npm install, npm run build, npm start — all in one sequential block
  • Fixed port to 4202 (was 4200)

Initializing Submodule Common-UI section

  • Removed broken git init instructions (which would create a separate git repo inside Common-UI instead of using the submodule pointer)
  • Replaced with the correct git submodule update --init --recursive approach
  • Documented branching to develop

What This Does NOT Change

  • No runtime code changes
  • No package.json, Angular config, or dependency changes

Summary by CodeRabbit

  • Documentation
    • Revised setup and installation instructions for improved clarity and workflow efficiency
    • Updated Node.js version requirement to v18.10.0 with nvm setup guidance
    • Simplified build and startup process with streamlined npm commands
    • Updated local development access URL to http://localhost:4202/#/login
    • Enhanced Common-UI submodule initialization instructions and workflow

Review Change Stack

@sonarqubecloud
Copy link
Copy Markdown

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: aa88d20f-2646-4df6-be0b-1c51155f9af5

📥 Commits

Reviewing files that changed from the base of the PR and between 91045e5 and de5692b.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md setup instructions updated to use nvm-managed Node.js v18.10.0, npm-based build workflow, and git clone with --recurse-submodules. Common-UI submodule initialization procedure simplified with root-level git commands and clearer develop branch checkout guidance.

Changes

Setup and Installation Instructions

Layer / File(s) Summary
Prerequisites and installation flow
README.md
Prerequisites section updated to specify Node.js v18.10.0 with nvm guidance. Installation steps revised to use git clone --recurse-submodules, nvm install/nvm use, npm install, npm run build (with npm run build-dev noted), npm start, and open the app at http://localhost:4202/#/login. Prior Maven-based and generic installation wording removed.
Submodule initialization instructions
README.md
Common-UI submodule initialization section rewritten with concise root-based workflow: git submodule update --init --recursive, git checkout develop, git pull origin develop, plus clarifying note that --recurse-submodules already handles initialization.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop through docs, so fresh and bright,
Node and npm, now set right—
Submodules dance with cleaner grace,
Setup instructions find their place! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main changes: README documentation updates for setup instructions and submodule initialization.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant