Skip to content

Commit eee7e73

Browse files
shenxianpengclaude
andcommitted
fix: drop the header logo, which read as a second status signal
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
1 parent c6dd962 commit eee7e73

2 files changed

Lines changed: 19 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ ran.
242242

243243
Passing runs stay to one line, with the detail folded away:
244244

245-
> <img src="https://raw.githubusercontent.com/commit-check/commit-check-action/main/assets/logo.png" width="24" align="top" alt=""> **Commit Check**
245+
> **Commit Check**
246246
>
247247
> ✅ **All 3 checks passed**
248248
>
@@ -266,7 +266,7 @@ Passing runs stay to one line, with the detail folded away:
266266
Failures open with a count, then a table of only the scopes that failed — every
267267
rule ID links to its documentation — with the full tree still one click away:
268268

269-
> <img src="https://raw.githubusercontent.com/commit-check/commit-check-action/main/assets/logo.png" width="24" align="top" alt=""> **Commit Check**
269+
> **Commit Check**
270270
>
271271
> ❌ **2 of 4 checks failed**
272272
>

‎main.py‎

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,23 @@
2929
# CodSpeed all use for the same purpose.
3030
COMMENT_MARKER = "<!-- commit-check-action -->"
3131

32-
#: Logo shown next to the report title.
33-
#
34-
# Served from this repository rather than commit-check.com so the report has no
35-
# cross-repository dependency, and as PNG rather than SVG because GitHub proxies
36-
# comment images through camo, which handles SVG unreliably. Point this at a
37-
# single org-wide asset if the other tools grow the same header.
38-
#
39-
# This is the org's *filled* mark (branding/avatar.png), not the transparent
40-
# logo-mark. At this size a stroke has almost no visual weight -- the wordless
41-
# mark rendered as a faint tick, worst on dark backgrounds -- while a filled
42-
# tile holds up. It is the asset the branding README calls out as legible
43-
# small, and the width below matches the h2 cap height so the icon is not
44-
# smaller than the words next to it.
45-
LOGO_URL = (
46-
"https://raw.githubusercontent.com/commit-check/commit-check-action/main/"
47-
"assets/logo.png"
48-
)
49-
5032
#: Report heading. h2 rather than h1: this renders inside a PR comment, where an
5133
#: h1 is louder than anything else on the page.
52-
REPORT_TITLE = f'## <img src="{LOGO_URL}" width="24" align="top" alt=""> Commit Check'
34+
#
35+
# Deliberately carries no logo. The org mark is a check inside a rounded tile,
36+
# which is the same object GitHub's ✅ is — same shape, same silhouette, only
37+
# the hue differs. Putting it immediately above the verdict line meant a failing
38+
# report opened with a tick and then said "❌ 2 of 4 checks failed": the first
39+
# symbol the eye lands on contradicted the second, and it did so precisely when
40+
# the reader most needs to read the result quickly.
41+
#
42+
# The verdict line is the one status signal in this report, and one is the right
43+
# number. "Commit Check" in words is unambiguous branding; a checkmark next to a
44+
# failure is not.
45+
#
46+
# Do not "fix" this by showing the logo only on success — that makes the logo's
47+
# presence itself a status signal, which is the same defect wearing a hat.
48+
REPORT_TITLE = "## Commit Check"
5349

5450
#: Prefixes of report bodies written by earlier versions, kept so the first run
5551
#: after upgrading adopts the existing comment instead of posting a second one.
@@ -574,7 +570,7 @@ def _scope_value(scope: ScopeResult, max_len: int = 60) -> str:
574570
# Success:
575571
#
576572
# <!-- commit-check-action -->
577-
# ## <img src="..." width="24" align="top" alt=""> Commit Check
573+
# ## Commit Check
578574
#
579575
# ✅ **All 5 checks passed**
580576
#
@@ -599,7 +595,7 @@ def _scope_value(scope: ScopeResult, max_len: int = 60) -> str:
599595
# Failure:
600596
#
601597
# <!-- commit-check-action -->
602-
# ## <img src="..." width="24" align="top" alt=""> Commit Check
598+
# ## Commit Check
603599
#
604600
# ❌ **1 of 5 checks failed**
605601
#

0 commit comments

Comments
 (0)