Skip to content

docs: switch the commit-check badge to the new brand - #584

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/brand-badge
Sep 24, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
chore/brand-badge

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Swaps the commit-check | enabled badge in the README for the new brand's version:

  • the same Signal Blue #2c9ccd as before;
  • an Ink (#0b1620) label;
  • the Commit Check mark in place of the generic Git logo;
  • a link to commit-check.com instead of the GitHub repository.

This matches commit-check/commit-check.com#43 and commit-check/.github#61. The logo is a shields.io data URI of branding/badge-logo.svg in the org repository.

README only. The badge renders from shields.io today, so this does not have to wait for the other PRs.

Summary by CodeRabbit

  • Documentation
    • Updated the commit-check badges in the README header, Quick Start example, and badging guide with a refreshed logo and color scheme.
    • Badge links now direct to commit-check.com instead of the GitHub repository.

The badge keeps its Signal Blue #2c9ccd, takes an Ink label, and carries
the Commit Check mark in place of the generic Git logo, matching
commit-check.com and the org branding (commit-check/.github#61). It now
links to commit-check.com, where a reader who wonders what the badge
means finds out.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner September 24, 2026 10:10
@github-actions github-actions Bot added chore documentation Improvements or additions to documentation labels Sep 24, 2026
@coderabbitai

coderabbitai Bot commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

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: 425eae09-f49e-4c6c-9488-3c2d496f167c

📥 Commits

Reviewing files that changed from the base of the PR and between 52b0a90 and 3af6af5.

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

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


📝 Walkthrough

Walkthrough

The README’s commit-check badges now use a shields.io URL with a custom SVG logo and updated colors. The badge links now point to commit-check.com.

Changes

README badges

Layer / File(s) Summary
Update README badge examples
README.md
The header, Quick Start example, and repository badging instructions use the updated badge URL, logo, colors, and link destination.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 3af6a

The updated README badges render from the checked URLs, and no material merge risk remains.

🚥 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 README badge update and the brand change.
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.

@sonarqubecloud

Copy link
Copy Markdown

@shenxianpeng shenxianpeng added skip-changelog and removed documentation Improvements or additions to documentation chore labels Sep 24, 2026
@shenxianpeng
shenxianpeng merged commit 4ff4966 into main Sep 24, 2026
10 checks passed
@shenxianpeng
shenxianpeng deleted the chore/brand-badge branch September 24, 2026 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant