Skip to content
This repository was archived by the owner on Nov 23, 2025. It is now read-only.

docs: Add build status badges for all services in README.md for impro…#1

Merged
RandithaK merged 1 commit intomainfrom
dev
Oct 11, 2025
Merged

docs: Add build status badges for all services in README.md for impro…#1
RandithaK merged 1 commit intomainfrom
dev

Conversation

@RandithaK
Copy link
Member

@RandithaK RandithaK commented Oct 11, 2025

…ved CI visibility

Summary by CodeRabbit

  • Documentation
    • Added build status badges for main and dev branches at the top of the README.
    • Refreshed Key Responsibilities section with clearer bullet points.
    • Introduced tech stack badges (Spring Boot, PostgreSQL, Docker) and updated the Tech Stack section.
    • Improved API Information formatting with clearer labels for Local Port and Swagger UI.
    • Fixed and clarified Running Locally instructions, including corrected docker-compose command and proper code block formatting.

@coderabbitai
Copy link

coderabbitai bot commented Oct 11, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

README.md updated to add build status and tech stack badges, revise responsibility and API info formatting, and correct the Running Locally code block and command, including proper code fencing.

Changes

Cohort / File(s) Summary of Changes
Documentation/README
README.md
Added build status badges (main/dev). Replaced responsibility lines with new prefixed entries. Introduced Spring Boot/PostgreSQL/Docker badges and updated Tech Stack. Reformatted API info with bold labels. Fixed docker-compose command and closed code fence in Running Locally section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I thump the docs with gentle pride,
New badges shine, side by side.
Stacks in colors, ports in bold,
Commands now tidy, lines controlled.
With whiskers twitch and ears held high—
Ship the README, crisp and spry! 🥕✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dev

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34fd1d6 and 2511a4e.

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

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

@RandithaK RandithaK merged commit f171a90 into main Oct 11, 2025
2 of 3 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant