brand icon indicating copy to clipboard operation
brand copied to clipboard

ADR: Primer Brand source of truth

Open rezrah opened this issue 3 years ago • 4 comments

Primer Brand has matured significantly in Q4, so it's important to codify aspects of its data governance - specifically its source of truth - for our users and future maintainers.

This PR attempts to describe the relationship between Figma, design tokens and the resulting React component library.

Read the ADR here:

https://github.com/primer/react-brand/blob/rezrah/adr-source-of-truth/contributor-docs/adrs/adr-001-source-of-truth.md

Any questions? please ask away in the comments. All feedback appreciated.

rezrah avatar Jun 20 '22 10:06 rezrah

⚠️ No Changeset found

Latest commit: 119157f499e2839ed2cf4272c49e4ba5be679dea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Jun 20 '22 10:06 changeset-bot[bot]

@ashygee @rezrah - This line under Alternative Approaches is the only thing that gives me pause 🤔 .

Brand art direction is usually defined and governed by the Brand Design team. They work directly with Figma as opposed to code. Achieving sign-off through PRs could be logistically expensive and inconvenient.

It's unclear to me what we define as tokens as it feels quite broad. I'm wondering how we will handle sub-brands vs our core brand, and various themes as we define them in the brand (not necessarily as defined in systems or engineering). Can we provide more clarity on this and outline some examples? It's hard to give a thumbs up without it.

ajashams avatar Jun 21 '22 15:06 ajashams

Design Approval ✅

After a clarifying conversation with @rezrah and @ashygee, here's how I understand this document:

  • Design tokens will be the source of truth for styles across design and code
  • This ADR does not define the design tokens, it merely proposes that we use them as a source of truth
  • Gloss Web's current styles will inform these design tokens. This is because brand is typically defining styles in Figma and is the most accurate representation of preferred changes.

All of this sounds good to me! My previous comment was in reference to how we name design tokens, but this will be explored once we get agreement on using design tokens. 👍 from me.

ajashams avatar Jun 21 '22 17:06 ajashams

Oops, didn't mean to re-request my review. Please ping me here if/when you'd like me to take another pass. Thanks!

lesliecdubs avatar Jun 28 '22 20:06 lesliecdubs