feat: host the README badge at commit-check.com/badge.svg - #46
Conversation
The badge a README carries today is a shields.io URL with the Commit Check mark base64-encoded into it: 519 characters to copy, and a third-party request on every page view. conventionalbranch.org/badge.svg already shows the alternative. docs/badge.svg is a hand copy of what shields.io renders for the brand badge -- same size, colors, flat style and textLength, with the mark drawn as vectors instead of an embedded image. Rendered at 6x beside the shields.io original, no pixel differs by more than 8%, so the two look the same in a README row. MkDocs copies it to the site root. Getting started gains a short "Show that you use it" section with the Markdown and reStructuredText snippets. Until now only the READMEs documented the badge.
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe getting-started guide adds a “Show that you use it” section with a project badge and copyable Markdown and reStructuredText snippets. ChangesBadge documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Feature Merge Risk: ⚪ Minimal · up to The badge snippets resolve to the published badge. No merge blocker was identified; the change is ready for normal checks. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
1 participant
This serves the Commit Check badge from the site, so the snippet a user copies becomes one line:
Today the snippet is a 519-character shields.io URL with the mark base64-encoded into it, and every page view makes a request to a third party. conventionalbranch.org/badge.svg already works this way.
What's in it
docs/badge.svg. This is a hand-written copy of the shields.io render of the brand badge frombranding/README.md. It has the same 157×20 size, the same colors and flat style, and the sametextLength, which keeps the text identical on machines without Verdana. The mark is drawn as vectors instead of an embedded image. A comment in the file explains all of this, including the contrast trade-off: white on Signal Blue is about 3:1, which is the color the badge has always had. MkDocs copies the file to the site root.Checks
rsvg-convertat 6× and compared them with ImageMagick. At 8% fuzz, 0 pixels differ, and the RMSE is 1.5e-5.mkdocs build --strictpasses (withSOCIAL_CARDS=false).site/badge.svgis in the output, and the page links it as../badge.svg.python -m pytest tests/ -qpasses with the released commit-check installed (10 tests). The pins and the changelog were already at 2.18.1, so nothing needed bringing into step.After this deploys
Once
https://commit-check.com/badge.svgis live, the long snippet elsewhere can switch to the short one:branding/README.mdin.github.The badge rows in those READMEs can stay on shields.io. Only the snippet users copy needs to change.
Summary by CodeRabbit