Skip to content

docs: standardize README badges across all repos#72

Merged
devops-thiago merged 1 commit intomainfrom
docs/standardize-readme-badges
Mar 5, 2026
Merged

docs: standardize README badges across all repos#72
devops-thiago merged 1 commit intomainfrom
docs/standardize-readme-badges

Conversation

@devops-thiago
Copy link
Owner

  • Align badge order: CI → language → framework → license → Codecov → Sonar Quality Gate → Sonar Coverage → OTel → Docker → Docker Hub → Docker Pulls
  • Rename SonarCloud coverage badge label to 'Sonar Coverage' for clarity (was 'Coverage', clashing with Codecov)
  • Use shields.io github/actions/workflow for CI badges (consistent style and avoids encoding issues)
  • Use shields.io github/license for license badges (dynamic, no hardcoded spdx text)
  • Use shields.io codecov for coverage badges (consistent style)

What

Why

Changes

Test Plan

  • Unit tests pass (make test / npm run test:unit / dotnet test / poetry run pytest)
  • Linter / formatter clean (make fmt-check / npm run lint / dotnet format --verify-no-changes)
  • Manual smoke test against local docker compose up
  • Integration tests pass (if DB available)
  • No new high-severity vulnerabilities (npm audit --audit-level=high / trivy)

Checklist

  • Commit messages follow Conventional Commits (type(scope): description)
  • No debug output, commented-out code, or TODOs left behind
  • Equivalent change applied to all relevant repos (if cross-repo feature)
  • Docs / README updated if behaviour or setup changed

- Align badge order: CI → language → framework → license → Codecov →
  Sonar Quality Gate → Sonar Coverage → OTel → Docker → Docker Hub →
  Docker Pulls
- Rename SonarCloud coverage badge label to 'Sonar Coverage' for
  clarity (was 'Coverage', clashing with Codecov)
- Use shields.io github/actions/workflow for CI badges (consistent
  style and avoids encoding issues)
- Use shields.io github/license for license badges (dynamic, no
  hardcoded spdx text)
- Use shields.io codecov for coverage badges (consistent style)
Copilot AI review requested due to automatic review settings March 5, 2026 02:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR standardizes the README badge section by reordering badges to a consistent order, replacing several badge providers with shields.io equivalents, renaming the SonarCloud coverage badge to avoid a naming clash with Codecov, and removing a verbose "Project Status" section in favor of a clean badge-only header.

Changes:

  • Replaced/reordered all README badges to follow the documented order: CI → language → license → Codecov → Sonar Quality Gate → Sonar Coverage → OTel → Docker → Docker Hub → Docker Pulls
  • Switched CI badge from GitHub workflow SVG URL to shields.io github/actions/workflow style, license badge to shields.io github/license, and Codecov badge to shields.io codecov/c
  • Removed the "Project Status" checklist section and added new Docker Hub version and Docker Pulls badges

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 5, 2026

@codecov
Copy link

codecov bot commented Mar 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.97%. Comparing base (a0a5704) to head (b74f7b8).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #72   +/-   ##
=======================================
  Coverage   89.97%   89.97%           
=======================================
  Files           7        7           
  Lines         459      459           
  Branches       61       61           
=======================================
  Hits          413      413           
  Misses         30       30           
  Partials       16       16           
Flag Coverage Δ
unittests 89.97% <ø> (ø)

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.

@devops-thiago devops-thiago merged commit 015a3c8 into main Mar 5, 2026
14 checks passed
@devops-thiago devops-thiago deleted the docs/standardize-readme-badges branch March 5, 2026 02:37
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