fix: drop the header logo, which read as a second status signal - #262
Merged
Conversation
Raised by @shenxianpeng looking at a failing report: is this thing telling me it passed or failed? The org mark is a white check inside a rounded tile. GitHub's ✅ is a white check inside a rounded square. Same shape, same silhouette, differing only in hue -- and hue is the weakest channel to carry meaning at 24px. So a failing report opened with a tick and then said "❌ 2 of 4 checks failed": the first symbol the eye lands on contradicted the second, and it did so exactly when the reader most needs to take the result in at a glance. Success was fine, both symbols agreeing. That is what hid it: the ambiguity only appears on failure, which is the case that matters most and the one you see least while building the thing. Three changes walked it here, each locally reasonable. The original wordmark badge carried "COMMIT" in it, so it read as a logo. #259 replaced it with the new wordless mark, which was faint but still decoration. #261 filled it in to give it presence -- and a filled tile with a check in it is not decoration, it is a status chip. Adding visual weight added semantic weight with it. So the header is now plain "## Commit Check". The verdict line is the single status signal, which is the right number of them; the words carry the brand without claiming an outcome. assets/logo.png stays. It is unreferenced by this repo now, but the raw URL is public and may be linked from outside, and 2.8 KB is cheaper than a broken image somewhere I cannot see. Comment identity is unaffected: comments are matched on COMMENT_MARKER, an invisible HTML comment, not on the title, so existing comments are still adopted and edited in place rather than duplicated. The golden tests build their expected header from main.REPORT_TITLE, so they followed the change without edits; 99 pass. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01U9zFxq8V4qxG4aMzJhGBFn
Contributor
Commit Check✅ All 5 checks passed Show all 5 checkscommit-check 2.13.1 · Rules reference |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe report heading no longer includes the Commit Check logo image. The code and README examples now use a plain ChangesReport heading update
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem
Raised by @shenxianpeng looking at a failing report: is this thing telling me it passed or failed?
The org mark is a white check inside a rounded tile. GitHub's
✅is a white check inside a rounded square. Same shape, same silhouette — only the hue differs, and hue is the weakest channel to carry meaning at 24px.So a failing report read:
The first symbol the eye lands on contradicts the second — and it does so exactly when the reader most needs to take the result in at a glance.
Success was fine, both symbols agreeing. That is what hid it: the ambiguity appears only on failure, which is the case that matters most and the one you see least while building the thing.
How it got here
Three changes, each locally reasonable:
#261 set out to give the mark presence. Adding visual weight added semantic weight with it — that's the bit I got wrong there, and this reverses it.
What changed
The header is now plain
## Commit Check. The verdict line is the single status signal, which is the right number of them; the words carry the brand without claiming an outcome.Also updated: the two header mockups in
main.py's output-spec comment, and the two rendered previews in the README, so the documented layout matches what ships.LOGO_URLis gone since nothing references it.assets/logo.pngstays — unreferenced by this repo now, but the raw URL is public and may be linked from outside, and 2.8 KB is cheaper than a broken image somewhere I can't see.Why not the alternatives
Verification
COMMENT_MARKER, an invisible HTML comment, not on the title — so existing comments are still adopted and edited in place rather than duplicated. (_find_own_commentsonly falls back toLEGACY_TITLESwhen no marked comment exists.)99 passed, black clean. The golden tests build their expected header frommain.REPORT_TITLE, so they followed the change without edits — the layout is still pinned exactly.🤖 Generated with Claude Code
https://claude.ai/code/session_01U9zFxq8V4qxG4aMzJhGBFn
Generated by Claude Code
Summary by CodeRabbit