Skip to content

feat: add a theme-aware banner and a wordless avatar - #49

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/refresh-sample-output-602anc
Aug 6, 2026
Merged

feat: add a theme-aware banner and a wordless avatar#49
shenxianpeng merged 1 commit into
mainfrom
claude/refresh-sample-output-602anc

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Aug 6, 2026

Copy link
Copy Markdown
Member

The org profile opened with no visual at all. The only logo line was commented
out, and it pointed at logo-small.jpg — a real JPEG, so no transparency, so
a white box on any dark background.

Banner

Mark, wordmark and tagline on the left; a passing check report on the right.
The report is the point: a banner that only repeats the project name teaches
the reader nothing, while a passing report says what the tool is for before
the tagline is read.

Light and dark are paired in a <picture>, so it follows the reader's theme.
Brand colour #2c9ccd throughout; the dark variant sits on GitHub's own
#0d1117 with the ink and muted tones re-picked for contrast rather than
reused from the light one.

Avatar

branding/avatar.png — upload it in the org settings, I can't set that from
here.

It drops the wordmark deliberately. GitHub shows org avatars at roughly
40px in most places, and at that size "COMMIT" is an unreadable smudge.
The current avatar also crops the check so its upper-right arm is cut off by
the frame
, and sits off-centre with dead space in the top-left.

White on brand blue was chosen over blue-on-white and blue-on-ink because it
holds the most contrast at small sizes, and it uses the same lockup as the
banner — so the org icon and the banner read as one brand instead of two
treatments of a similar idea. I rendered all three at 280 / 80 / 40 / 20px
before picking.

Details worth knowing

  • PNG, not SVG, in the README. GitHub proxies README images through camo,
    and camo handles SVG unreliably — the same reason commit-check-action
    serves its comment logo as PNG. The .svg files beside them are the source;
    edit those and re-render.
  • The h1 and the repeated tagline are gone. The banner states both, and
    the org name already appears in GitHub's page chrome directly above it —
    keeping all three meant saying "Commit Check" three times in a row. Say the
    word if you would rather keep an h1 for the case where images are blocked;
    the alt text covers that today.
  • logo.jpg and logo-small.jpg are left in place. Nothing in the repos I
    can see references them, but something outside might, so removing them is
    your call. branding/README.md records why neither should be used again —
    including that logo.jpg is actually a PNG wearing a .jpg extension.

Typeface

Liberation Sans (Arial-metric). It is clean but not distinctive — no Inter or
similar was available where these were rendered. If you want a stronger
wordmark, supply a font file and I will re-cut the banner; the SVG sources
make that a small change.


Generated by Claude Code

Summary by CodeRabbit

  • Documentation

    • Added branding guidance covering colours, mark usage, image formats, avatars, and legacy assets.
    • Documented when to use PNG versus SVG images in README content.
  • Style

    • Updated the profile README with responsive branding that automatically adapts to dark and light themes.
    • Replaced the previous placeholder logo and introductory text with the new branded presentation.

The profile opened with no visual at all — the only logo line was commented
out, and pointed at logo-small.jpg, a real JPEG with no transparency that
renders as a white box on any dark background.

The banner carries the mark, the wordmark and the tagline on the left, and a
passing check report on the right. A banner that only repeats the project
name teaches the reader nothing; the report says what the tool is for before
the tagline is read. Light and dark are paired in a <picture>, so it follows
the reader's theme.

The avatar drops the wordmark on purpose. GitHub shows org avatars at around
40px in most places, where "COMMIT" is an unreadable smudge — and the current
one is cropped so that the check's upper-right arm is cut off by the frame.
White on brand blue reads at 20px and matches the banner lockup, so the icon
and the banner are visibly one brand.

PNGs are what the README references, because GitHub proxies images through
camo and camo handles SVG unreliably. The SVGs beside them are the source.

The h1 and the repeated tagline are gone: the banner states both, and the org
name already appears in GitHub's own page chrome above it.

logo.jpg and logo-small.jpg are left in place in case something outside this
repository links to them, and branding/README.md says why neither should be
used again.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U9zFxq8V4qxG4aMzJhGBFn
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0efd5850-eff0-4b21-86a5-f472dc674c90

📥 Commits

Reviewing files that changed from the base of the PR and between 1d10ed2 and 2233bff.

⛔ Files ignored due to path filters (8)
  • branding/avatar.png is excluded by !**/*.png
  • branding/avatar.svg is excluded by !**/*.svg
  • branding/banner-dark.png is excluded by !**/*.png
  • branding/banner-dark.svg is excluded by !**/*.svg
  • branding/banner-light.png is excluded by !**/*.png
  • branding/banner-light.svg is excluded by !**/*.svg
  • branding/logo-mark.png is excluded by !**/*.png
  • branding/logo-mark.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • branding/README.md
  • profile/README.md

📝 Walkthrough

Walkthrough

The change documents branding specifications and legacy asset limitations. The profile README now uses responsive dark- and light-mode PNG banners with descriptive alt text.

Changes

Branding documentation and profile integration

Layer / File(s) Summary
Branding specifications and legacy guidance
branding/README.md
The documentation defines brand colours, mark design, asset usage, PNG guidance, avatar rationale, and legacy-file limitations.
Responsive profile branding
profile/README.md
The README replaces the commented logo and title with dark- and light-mode PNG images in a <picture> element.

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

🚥 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 summarizes the main changes: a theme-aware banner and a wordless avatar.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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)
  • Create PR with unit tests
  • Commit unit tests in branch claude/refresh-sample-output-602anc

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

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

Commit-Check ✔️

@shenxianpeng
shenxianpeng merged commit 977da5e into main Aug 6, 2026
3 checks passed
@shenxianpeng
shenxianpeng deleted the claude/refresh-sample-output-602anc branch August 6, 2026 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants