Skip to content

docs: point the badge snippet at commit-check.com/badge.svg - #294

Merged
shenxianpeng merged 1 commit into
mainfrom
docs/short-badge-snippet
Sep 27, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
docs/short-badge-snippet

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

commit-check.com has served the badge at https://commit-check.com/badge.svg since commit-check/commit-check.com#46. This PR switches the Show that you use it snippet to that one line:

[![commit-check](https://commit-check.com/badge.svg)](https://commit-check.com)

Before, the snippet was a 519-character shields.io URL with the mark base64-encoded into it. The badge shown above the snippet now uses the hosted file too, so readers see exactly what they will get.

The hosted file returns 200 with image/svg+xml, and its content matches docs/badge.svg on commit-check.com's main. Compared with the shields.io render at 6×, no pixel differs, so a README that keeps the old URL looks the same.

Summary by CodeRabbit

  • Documentation
    • Updated the badge example to use a shorter badge URL.

commit-check.com now serves the badge (commit-check/commit-check.com#46),
so the snippet a user copies is one line instead of a 519-character
shields.io URL with the mark base64-encoded into it. The badge shown
above the snippet is the hosted one as well, so it shows exactly what
the user will get.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner September 27, 2026 16:59
@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: faa2eb63-f7a5-40af-b273-87ae1ef7aa65

📥 Commits

Reviewing files that changed from the base of the PR and between 03f1b9f and b7c11c4.

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

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README now uses https://commit-check.com/badge.svg for the displayed badge and its copyable Markdown snippet. The link target remains unchanged.

Changes

README badge

Layer / File(s) Summary
Update badge URL
README.md
The displayed badge and copyable Markdown snippet use https://commit-check.com/badge.svg. The link target is unchanged.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to b7c11

The README uses the shorter hosted badge URL; no concrete merge-blocking risk is evident.

Architecture Summary

Architecture risk: 🔵 Low · up to b7c11

The change affects 1 system.

Changed systems: README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Replaces the Shields.io badge URL in both the displayed badge and its copyable Markdown snippet with https://commit-check.com/badge.svg; the link target remains unchanged.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating the badge snippet to use the hosted commit-check.com badge URL.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)
  • Commit to this branch
  • Create a new PR

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.

@github-actions

Copy link
Copy Markdown
Contributor

Commit Check

✅ All 5 checks passed

Show all 5 checks
Commit message
  ✔ PR title (docs: point the badge snippet at commit-check.com/badge.svg)
  ✔ Commit 1/1 (b7c11c4) (docs: point the badge snippet at commit-check.com/badge.svg)
Branch
  ✔ Branch (docs/short-badge-snippet)
Author
  ✔ Author name (Xianpeng Shen)
  ✔ Author email (xianpeng.shen@gmail.com)

commit-check 2.18.1 · Rules reference

@codecov

codecov Bot commented Sep 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.11%. Comparing base (03f1b9f) to head (b7c11c4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #294   +/-   ##
=======================================
  Coverage   95.11%   95.11%           
=======================================
  Files           1        1           
  Lines         614      614           
=======================================
  Hits          584      584           
  Misses         30       30           
Flag Coverage Δ
unittests 95.11% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

@shenxianpeng
shenxianpeng merged commit 82a93ea into main Sep 27, 2026
22 checks passed
@shenxianpeng
shenxianpeng deleted the docs/short-badge-snippet branch September 27, 2026 17:02
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Sep 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant