Skip to content

CONTRIBUTING points at design tokens that no longer exist after the redesign #34

Description

@royalpinto007

What is wrong

The "UI / bug fixes" section of CONTRIBUTING.md (line ~83) tells contributors which design tokens to use:

Match the existing design tokens (bg-canvas, accent-red, accent-red-muted, text-tertiary, etc.) defined in tailwind.config.ts. Use text-accent-red-muted (not text-accent-red) when placing red text on bg-accent-red-soft backgrounds to pass WCAG AA contrast.

None of the red tokens exist any more. tailwind.config.ts defines the accent as amber:

accent: "#f5a524",
"accent-soft": "#20170a",
"accent-strong": "#ffc25c",

plus a separate semantic severity scale (sev-critical, sev-high, sev-medium, sev-low, each with a -soft variant). Grepping the whole of app/, components/, and lib/ for accent-red returns zero hits: the string survives only in CONTRIBUTING.md.

The class names in that paragraph are also written without their Tailwind prefixes, so bg-canvas and text-tertiary read as usable classes when the actual utilities are bg-bg-canvas and text-text-tertiary (the color keys themselves are bg-canvas and text-tertiary). See components/ui/Card.tsx and components/ui/Button.tsx for how they are really written.

Why it matters

This is the one paragraph telling a first-time contributor how to make a UI change look native to the project, and following it produces classes that silently render nothing. It also loses a real accessibility rule that the redesign kept: lib/constants/severity.ts documents that "every consumer must also render the label or the tick count, never colour alone".

What to change

In CONTRIBUTING.md:

  1. Replace the stale red token names with the current amber accent set: accent, accent-soft, accent-strong.
  2. Mention the severity scale as separate from the brand accent, and carry over the never-colour-alone rule from the doc comment in lib/constants/severity.ts.
  3. Write the examples as the utilities a contributor actually types, for example bg-bg-canvas, text-text-primary, border-border-default.
  4. Drop or restate the WCAG sentence. Do not invent a replacement contrast pairing. If you want to assert one, check the real hex values in tailwind.config.ts with a contrast checker first and say in the PR which pairing you measured.

Docs only.

Verify

npm run format
npx prettier --check .

Comment here to claim it and ask anything you are unsure about. You will usually get a reply within a day.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions