Skip to content

docs: add brand rules checklist for contributors - #526

Merged
dadadave80 merged 1 commit into
Heliobond:mainfrom
AbimbolaDann:fix/issue-376-document-the-design-and-brand-rules-for
Aug 31, 2026
Merged

docs: add brand rules checklist for contributors#526
dadadave80 merged 1 commit into
Heliobond:mainfrom
AbimbolaDann:fix/issue-376-document-the-design-and-brand-rules-for

Conversation

@AbimbolaDann

Copy link
Copy Markdown
Contributor

Overview

This PR adds a contributor-facing brand rules checklist to CONTRIBUTING.md, consolidating the design rules currently enforced by review comments and scattered token comments into a single PR checklist.

Related Issue

Changes

📝 Brand Rules Checklist

  • [ADD] CONTRIBUTING.md
    • Adds a Brand Rules section with a single contributor-facing checklist.
    • Captures the five enforced rules:
      • No all-caps headlines
      • Mono tabular numerals
      • Signed deltas
      • Solar never the sole carrier
      • No emoji
    • Provides concrete examples and references to README.md and src/styles/tokens/colors.css.

Verification Results

$ grep -E "no all-caps|mono tabular|signed deltas|solar|no emoji" CONTRIBUTING.md
✅ All 5 brand rules found in checklist

Manual acceptance check:
✅ Single checklist entry point in CONTRIBUTING.md
✅ Rules are stated as PR requirements
✅ Examples reference README.md and tokens/colors.css
Acceptance Criteria Status
Single checklist captures all brand rules ✅ Added to CONTRIBUTING.md with 5 enforceable rules
Rules are PR-facing ✅ Checklist is the first thing contributors see in the brand section
Examples make rules actionable ✅ Each rule pairs with a concrete reference or counter-example
Maintainable source of truth ✅ Replaces scattered review comments and token annotations

Closes #376

@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@AbimbolaDann Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

@AbimbolaDann is attempting to deploy a commit to the David Dada's projects Team on Vercel.

A member of the Team first needs to authorize it.

@sshdopey sshdopey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great addition! Consolidating the brand rules into a clear checklist in CONTRIBUTING.md makes it much easier for contributors to follow. The examples and references to README and tokens are helpful. Thanks for taking the time to document these rules and close issue #376. Keep up the awesome work! ❤️

@sshdopey

Copy link
Copy Markdown
Contributor

Approved! 🎉 I couldn't auto-merge this just yet (it may need a rebase or have a check still running). A maintainer can merge it whenever it's ready.

@dadadave80
dadadave80 merged commit 19c662d into Heliobond:main Aug 31, 2026
2 of 3 checks passed
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.

Document the design and brand rules for contributors

3 participants