Skip to content

fix(docs): replace broken README badges - #7

Merged
Liohtml merged 1 commit into
mainfrom
fix/readme-badges
May 21, 2026
Merged

fix(docs): replace broken README badges#7
Liohtml merged 1 commit into
mainfrom
fix/readme-badges

Conversation

@Liohtml

@Liohtml Liohtml commented May 21, 2026

Copy link
Copy Markdown
Owner

Replace codecov and PyPI badges (not configured/published) with working ones: Python 3.10+, GitHub release, GitHub stars.

Summary by CodeRabbit

  • Documentation
    • Updated README badges to display Python version, GitHub release, and GitHub stars information alongside the Apache 2.0 license badge.

Review Change Stack

- Remove codecov badge (not configured yet)
- Remove PyPI badges (not published yet)
- Add Python 3.10+ badge (static, always works)
- Add GitHub release badge (from releases)
- Add GitHub stars badge
@coderabbitai

coderabbitai Bot commented May 21, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b9a1086f-0c80-4ca4-8940-082a40482960

📥 Commits

Reviewing files that changed from the base of the PR and between 755e62d and dba137d.

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

📝 Walkthrough

Walkthrough

README.md badge row updated to remove codecov and PyPI version indicators, replacing them with Python 3.10+ version requirement, GitHub release status, and GitHub stars. Apache 2.0 license badge preserved.

Changes

README Badge Refresh

Layer / File(s) Summary
Badge row replacement
README.md
Badge row at lines 8–11 removes codecov, PyPI version, and Python versions; adds Python 3.10+, GitHub release, and GitHub stars badges; retains Apache 2.0 license badge.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit with star-bright eyes,
Polished badges, oh how nice!
GitHub shines, Python's clear,
No more codecov here,
Version badges now precise! ⭐

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the purpose of replacing badges but is missing required template sections like detailed Changes list, Testing checklist, and other structured information. Add the full description template structure including Changes section with bullet points, Testing checklist with all items, and Additional Notes section for completeness.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: replacing broken README badges with working ones, which matches the changeset summary.
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
  • Commit unit tests in branch fix/readme-badges

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

@Liohtml
Liohtml merged commit 357cf54 into main May 21, 2026
13 checks passed
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