Repository navigation
docs: move the brand to v4, the ticked commit mark #61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,65 @@ | ||
| # Branding v3a | ||
| # Branding v4 — Signal | ||
|
|
||
| Vector remaster of the original swoosh-check logo. Same composition, same | ||
| brand blue **#2c9ccd** — but clean curves that stay sharp at any resolution. | ||
| The COMMIT wordmark carries a background-coloured keyline so the letters stay | ||
| legible where they cross the check. | ||
| The mark is a commit on a history line, ticked: the thing Commit Check looks | ||
| at, and the verdict. It replaces the swoosh check of v1–v3. The same set is | ||
| used on [commit-check.com](https://commit-check.com), in the org avatar, the | ||
| README badge and the social previews, so they read as one project. | ||
|
|
||
| | Token | Value | Use | | ||
| | --- | --- | --- | | ||
| | Ink | `#0b1620` | Dark grounds, the mark's tile, text on light | | ||
| | Signal Blue | `#2c9ccd` | The mark, accents, buttons (with Ink text). The same blue the badge has always used | | ||
| | Paper | `#f4f6f7` | Light grounds | | ||
| | Display face | Bricolage Grotesque 700–800 | The wordmark and headings | | ||
| | Text face | Instrument Sans | Everything else | | ||
| | Code face | JetBrains Mono, ligatures off | Commands, rule IDs, output | | ||
|
|
||
| | File | Use it for | | ||
| | --- | --- | | ||
| | `avatar.png` | The org avatar. White swoosh on brand blue, 1024x1024, wordless. | | ||
| | `logo.png` / `logo-dark.png` | The full lockup for light / dark backgrounds (keyline colour differs). | | ||
| | `logo-mark.png` | The swoosh alone, transparent, brand blue. | | ||
| | `banner-light.png` / `banner-dark.png` | READMEs and docs. Pair them in a `<picture>`. Lockup on the left, a sample check run on the right, no tagline. Rasterized at 2× (2000×640) so they stay sharp on retina displays. | | ||
| | `favicon.svg` | Favicon / small tile. | | ||
| | `social-preview.png` | GitHub social preview (1280x640). Same two-column composition as the banner, with the domain under the lockup. Upload it per repository under Settings → Social preview; nothing does that for you. | | ||
| | `*.svg` | Source of truth. The wordmark uses Montserrat SemiBold; PNGs here are the reference renders. | | ||
|
|
||
| The banner is 1000×320 rather than the 1280×320 it used to be. Taking the | ||
| tagline out left a 443px void between the lockup and the check-run panel — | ||
| six times the outer margins — so the canvas was narrowed to the content | ||
| instead of padding the middle. Keep that in mind before adding anything | ||
| back: the layout is sized to what is in it. | ||
|
|
||
| None of these carry a tagline, and new ones should not either. A slogan baked | ||
| into a PNG cannot be reviewed in a diff, cannot be corrected without a machine | ||
| that has Montserrat installed, and goes stale silently — these read | ||
| "Clean commits. Clear standards." for a while after the rest of the org had | ||
| stopped saying it. The wordmark and the domain do not expire; the sentence belongs in the | ||
| prose next to the image, where changing it is a one-line diff. | ||
| | `avatar.png` | The org avatar, 1024×1024. Full-bleed Ink, because GitHub crops avatars itself. | | ||
| | `logo-mark.png` / `.svg` | The mark on its tile. | | ||
| | `logo.png` / `logo-dark.png` | The lockup for light / dark backgrounds, trimmed. | | ||
| | `banner-light.png` / `banner-dark.png` | READMEs. Pair them in a `<picture>`. Lockup on the left, a passing check run on the right, rendered at 2× (2000×640). | | ||
| | `social-preview.png` | The org-wide GitHub social preview (1280×640). | | ||
| | `social-preview-<repo>.png` | One per repository, with that repository's address and a panel showing what it does. | | ||
| | `favicon.svg` / `.png` | The small-size cut: at 16–32 px only the thickened tick remains. | | ||
| | `badge-logo.svg` | The logo inside the README badge (below). | | ||
|
|
||
| Reference the **PNGs** in READMEs, not the SVGs: GitHub proxies README images | ||
| through camo, which handles SVG unreliably — and the SVG text needs Montserrat | ||
| installed to render correctly. | ||
| Upload a social preview per repository under **Settings → Social preview**; | ||
| GitHub has no API for it, so nothing does that for you. | ||
|
|
||
| ## The README badge | ||
|
|
||
| [](https://commit-check.com) | ||
|
|
||
| To re-render the banners (needs Montserrat SemiBold installed): | ||
| The `logo=` parameter is `badge-logo.svg`, base64-encoded, with `+` written as | ||
| `%2b` (a bare `+` in a query string is a space). Shields.io only takes a | ||
| Simple Icons slug or a data URI there, which is why the URL is long. | ||
|
|
||
| ## Re-rendering | ||
|
|
||
| The images with text are HTML pages in `src/`, rendered with headless Chrome; | ||
| their fonts come from Google Fonts, so nothing has to be installed. The | ||
| shape-only SVGs are rendered with `rsvg-convert`. | ||
|
|
||
| ```bash | ||
| rsvg-convert -w 2000 -h 640 -o banner-light.png banner-light.svg | ||
| rsvg-convert -w 2000 -h 640 -o banner-dark.png banner-dark.svg | ||
| rsvg-convert -w 1280 -h 640 -o social-preview.png social-preview.svg | ||
| branding/src/render.sh | ||
| ``` | ||
|
|
||
| Different librsvg versions antialias glyph edges slightly differently, so a | ||
| re-render is a whole-image change even when you edited one line. To see what | ||
| you actually changed, render the file before and after with the *same* binary | ||
| and diff those two. | ||
| None of the images carry a tagline, and new ones should not either. A slogan | ||
| baked into a PNG cannot be reviewed in a diff and goes stale silently — v3's | ||
| read "Clean commits. Clear standards." for a while after the rest of the org | ||
| had stopped saying it. The wordmark, the domain and a repository's address do | ||
| not expire; the sentence belongs in the prose next to the image. | ||
|
|
||
| Reference the **PNGs** in READMEs, not the SVGs: GitHub proxies README images | ||
| through camo, which handles SVG unreliably, and `logo.svg` keeps its wordmark | ||
| as live text that needs the display face to render as designed. | ||
|
|
||
| ## Legacy files | ||
|
|
||
| `logo.jpg` and `logo-small.jpg` predate this set and are kept only because | ||
| something outside this repository may still link to them. Neither is fit for | ||
| new use: `logo.jpg` is a PNG wearing a `.jpg` extension, and `logo-small.jpg` | ||
| is a real JPEG, so it has no transparency and renders as a white box on any | ||
| dark background. Remove them once you have confirmed nothing points at them. | ||
| something outside this repository may still link to them; they now carry the | ||
| v4 lockup. `logo.jpg` is a PNG wearing a `.jpg` extension, and | ||
| `logo-small.jpg` is a real JPEG on white. Remove them once you have confirmed | ||
| nothing points at them. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document ImageMagick as a rendering requirement.
The re-rendering instructions name Chrome and
rsvg-convert, butbranding/src/render.shalso runsmagickfor both lockups. A reader who installs only the listed tools will stop at the first lockup. Add ImageMagick to this prerequisite list.🤖 Prompt for AI Agents