Skip to content

Show the coverage badge in the README - #499

Merged
tschm merged 1 commit into
mainfrom
coverage-badge
Jul 31, 2026
Merged

Show the coverage badge in the README#499
tschm merged 1 commit into
mainfrom
coverage-badge

Conversation

@tschm

@tschm tschm commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Coverage is already measured, published and sitting at 100% — the badge SVG and the HTML report are both live — but the README never linked either, so the number was reachable only by knowing the URL.

It also left the coverage column blank for this row in the tschm profile table, which harvests the badge from each repository's own README rather than reconstructing it, so that a project decides for itself what it publishes and under which URL.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a test coverage badge to the README.
    • The badge links directly to the generated HTML coverage report.

Coverage is already measured, published and sitting at 100%, but the
README never linked it, so the number was reachable only by knowing the
URL — and the coverage column stayed blank in the tschm profile table,
which harvests that badge from each repository's own README.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 31, 2026 10:02
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

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: abac1fcf-ed05-44b4-81ad-4cdcd7b1da38

📥 Commits

Reviewing files that changed from the base of the PR and between 7c32e9e and 60e0797.

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

📝 Walkthrough

Walkthrough

README.md now includes a coverage badge that links to the generated HTML coverage report.

Changes

Coverage documentation

Layer / File(s) Summary
Add coverage badge
README.md
Adds a coverage badge linked to the generated HTML coverage report.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change but omits the required Summary, Changes, Testing, Checklist, and issue reference sections. Use the repository template and add the required sections, testing status, checklist items, and issue reference or explain why they are not applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding the coverage badge to the README.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch coverage-badge

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.

@tschm
tschm merged commit cfd57ce into main Jul 31, 2026
63 of 64 checks passed
@tschm
tschm deleted the coverage-badge branch July 31, 2026 10:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a coverage badge to the repository README so the already-published coverage status and HTML report are discoverable directly from the project’s landing page (and can be harvested by external profile tooling that reads badges from README).

Changes:

  • Add a Coverage badge to README.md linking to the published HTML coverage report.

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

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