Skip to content

docs: add project status badges - #13

Merged
omarluq merged 5 commits into
mainfrom
docs/readme-badges
May 13, 2026
Merged

omarluq merged 5 commits into
mainfrom
docs/readme-badges

Conversation

@omarluq

@omarluq omarluq commented May 13, 2026

Copy link
Copy Markdown
Owner

Summary\n- add SonarCloud, Codecov, CodeRabbit, and DeepWiki badges to README\n- update Go reference badge to librecode.sh vanity module path\n\n## Validation\n- mise exec -- task ci

@coderabbitai

coderabbitai Bot commented May 13, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 54da6f67-2a4a-44db-8929-1a7c253f90e6

📥 Commits

Reviewing files that changed from the base of the PR and between 6c5c7a8 and 9f03c63.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated top badge row to include Codecov, CodeRabbit Reviews, and "Ask DeepWiki" badges.
    • Kept existing Go version, CI, release/version, MIT license, and Go Reference badges intact.
    • Added a SonarCloud Quality Gate badge near the bottom linking to the SonarCloud "new_code" summary.

Walkthrough

Top README badge row extended with Codecov, CodeRabbit Reviews, and Ask DeepWiki badges; a centered SonarCloud Quality Gate badge linking to the project "new_code" summary was added near the README footer.

Changes

Documentation updates

Layer / File(s) Summary
README header badge updates
README.md
Header badge row extended by adding Codecov, CodeRabbit Reviews, and Ask DeepWiki badges; existing header badges retained.
README SonarCloud badge insertion
README.md
Centered SonarCloud Quality Gate badge block inserted near the bottom, linking to the SonarCloud project new_code summary.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Badge-hopping through README rows,
New lights added where the header grows,
Codecov twinkles, reviews take flight,
Ask DeepWiki whispers through the night,
SonarCloud keeps the code polite.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add project status badges' clearly summarizes the main change - adding badges to documentation files.
Description check ✅ Passed The description is directly related to the changeset, listing the specific badges being added and mentioning the Go reference badge update.
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
  • Commit unit tests in branch docs/readme-badges

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

16-16: 💤 Low value

Consider using a theme-adaptive SonarCloud badge.

The SonarCloud badge currently uses sonarcloud-dark.svg, which may not render optimally in light mode. SonarCloud provides alternative badge formats that adapt to GitHub's theme.

Alternative badge approaches

Consider using a shields.io-based SonarCloud badge for consistency with other badges:

-  <a href="https://sonarcloud.io/summary/new_code?id=omarluq_librecode"><img src="https://sonarcloud.io/images/project_badges/sonarcloud-dark.svg" alt="SonarCloud Quality Gate"></a>
+  <a href="https://sonarcloud.io/summary/new_code?id=omarluq_librecode"><img src="https://img.shields.io/sonar/quality_gate/omarluq_librecode?server=https%3A%2F%2Fsonarcloud.io&style=flat&labelColor=24292e&logo=sonarqube&logoColor=white" alt="SonarCloud Quality Gate"></a>

Or use the white variant if you prefer the official badge:

-  <a href="https://sonarcloud.io/summary/new_code?id=omarluq_librecode"><img src="https://sonarcloud.io/images/project_badges/sonarcloud-dark.svg" alt="SonarCloud Quality Gate"></a>
+  <a href="https://sonarcloud.io/summary/new_code?id=omarluq_librecode"><img src="https://sonarcloud.io/images/project_badges/sonarcloud-white.svg" alt="SonarCloud Quality Gate"></a>
🤖 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` at line 16, The SonarCloud badge currently uses the static
dark-theme asset "sonarcloud-dark.svg" in README.md which may not display well
in light mode; update the anchor/image to a theme-adaptive badge by replacing
the current src with a shields.io SonarCloud badge URL (or swap to the official
white variant "sonarcloud-white.svg") so the badge adapts to GitHub
themes—locate the existing anchor/image that references "sonarcloud-dark.svg"
and replace its src (and alt text if desired) with the chosen adaptive badge
URL.
🤖 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`:
- Line 10: The README's Go Reference badge links to
"https://pkg.go.dev/librecode.sh" which 404s because the vanity import path
isn't configured; fix by either (A) configuring the vanity domain librecode.sh
(DNS + web server) to serve an HTML page containing the go-import meta tag
pointing to github.com/omarluq/librecode so pkg.go.dev resolves correctly, or
(B) revert the badge href to the canonical module path
"https://pkg.go.dev/github.com/omarluq/librecode" in the README badge (update
the href only, keeping the badge image if desired) so the badge points to a
working pkg.go.dev page.

---

Nitpick comments:
In `@README.md`:
- Line 16: The SonarCloud badge currently uses the static dark-theme asset
"sonarcloud-dark.svg" in README.md which may not display well in light mode;
update the anchor/image to a theme-adaptive badge by replacing the current src
with a shields.io SonarCloud badge URL (or swap to the official white variant
"sonarcloud-white.svg") so the badge adapts to GitHub themes—locate the existing
anchor/image that references "sonarcloud-dark.svg" and replace its src (and alt
text if desired) with the chosen adaptive badge URL.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b3fa6a91-145a-4137-b076-07713773c7a5

📥 Commits

Reviewing files that changed from the base of the PR and between cabc2bf and 59765c0.

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

Comment thread README.md Outdated
@codecov-commenter

codecov-commenter commented May 13, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@c7b6df8). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #13   +/-   ##
=======================================
  Coverage        ?   55.16%           
=======================================
  Files           ?      152           
  Lines           ?    15030           
  Branches        ?        0           
=======================================
  Hits            ?     8292           
  Misses          ?     5818           
  Partials        ?      920           
Flag Coverage Δ
unittests 55.16% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@omarluq
omarluq force-pushed the docs/readme-badges branch from 3cb2acb to 5bb2c8a Compare May 13, 2026 17:39
coderabbitai[bot]
coderabbitai Bot previously approved these changes May 13, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes May 13, 2026
@sonarqubecloud

Copy link
Copy Markdown

@omarluq
omarluq merged commit ef7d383 into main May 13, 2026
13 checks passed
@omarluq
omarluq deleted the docs/readme-badges branch May 23, 2026 04:40
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.

2 participants