Skip to content

update README and sync package version with pom#169

Open
nexpectArpit wants to merge 1 commit into
PSMRI:mainfrom
nexpectArpit:docs/update-documentation
Open

update README and sync package version with pom#169
nexpectArpit wants to merge 1 commit into
PSMRI:mainfrom
nexpectArpit:docs/update-documentation

Conversation

@nexpectArpit
Copy link
Copy Markdown

@nexpectArpit nexpectArpit commented May 8, 2026

📋 Description

JIRA ID:

updating the readme and synchronised pom.xml in package.json


✅ Type of Change

  • 🐞 Bug fix (non-breaking change which resolves an issue)
  • New feature (non-breaking change which adds functionality)
  • 🔥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🛠 Refactor (change that is neither a fix nor a new feature)
  • ⚙️ Config change (configuration file or build script updates)
  • 📚 Documentation (updates to docs or readme)
  • 🧪 Tests (adding new or updating existing tests)
  • 🎨 UI/UX (changes that affect the user interface)
  • 🚀 Performance (improves performance)
  • 🧹 Chore (miscellaneous changes that don't modify src or test files)

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

@drtechie please review it

Summary by CodeRabbit

  • Documentation

    • Updated build-from-source prerequisites and local setup instructions
    • Minimum JDK requirement raised to version 17 (previously 1.8)
    • Spring Boot requirement upgraded to version 3 (previously version 2)
    • Updated Swagger UI endpoint path for local development
  • Chores

    • Version updated to 3.6.1

@vanitha1822 @drtechie please review it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

📝 Walkthrough

Walkthrough

Version metadata and README documentation are updated to align with platform upgrades. The package version increments from 1.0.0 to 3.6.1. Build prerequisites now specify JDK 17 and Spring Boot v3. The local development Swagger UI endpoint URL is updated to the modern path.

Changes

Documentation and Version Updates

Layer / File(s) Summary
Version Metadata
package.json
Package version updated from 1.0.0 to 3.6.1.
Build Prerequisites
README.md
Prerequisites section updated to JDK 17 and Spring Boot v3, with Redis bullet reformatted.
Development Setup
README.md
Local development Swagger UI URL changed from /swagger-ui.html#!/ to /swagger-ui/index.html.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A version bump, now shiny and bright,
From one to three-point-six, what a sight!
JDK seventeen and Spring Boot's new way,
Swagger UI paths dance in modern display.
📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately captures both main changes: updating the README documentation and syncing the package.json version with pom.xml. It is specific and clearly summarizes the primary objectives.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

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

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.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 8, 2026

@nexpectArpit nexpectArpit marked this pull request as ready for review May 8, 2026 21:59
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