Skip to content
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

Carbon coverage: Refine message language and options #17599

Closed
Tracked by #16318
RichKummer opened this issue Sep 28, 2024 · 1 comment
Closed
Tracked by #16318

Carbon coverage: Refine message language and options #17599

RichKummer opened this issue Sep 28, 2024 · 1 comment
Assignees

Comments

@RichKummer
Copy link

RichKummer commented Sep 28, 2024

After our last feedback session with the design and development cohort, it is clear that the current roster of issues is confusing, with some message language being unclear or dated. We should update the messages and logic to make clear what each issue is highlighting.

Considerations:

  • The language should clarify that this is checking for v11 components/tokens.
  • Certain messages are likely outdated or not helpful for Carbon. These should be marked for removal.
  • Some opportunities should be added in case these become possible, such as surfacing detached components or v10 components.

See logic breakdown in Figma

@RichKummer
Copy link
Author

RichKummer commented Oct 4, 2024

Current messages

Logic Current message Updated message Update
A Carbon v11 component that has an element overridden, but not detached Overridden Carbon instance. Please reset changes Carbon v11 component is overridden  🔧 Update needed
A non-Carbon v11 component. Can be either local or from another library Instance is not a Carbon instance. N/A 🚫 Remove – Designers clarified that they might use many components not from v11 directly.
A mixed text element that is not totally using Carbon v11. A single text string can have mixed styling. Text is not from Carbon Text style is not from Carbon v11 🔧 Update needed
A text element that is a single style, which is not a v11 text color style. Text Color style should only use surface/text or feedback/text tokens  Text color is not from Carbon v11 🔧 Update needed
N/A Use a Divider Component instead N/A 🚫 Remove – likely a holdover from previous build
An effect that is not from Carbon v11 Effects not from Carbon's elevation styles Effect is not from Carbon v11 ⏸️ Logic update paused, remove message for now
Any element that uses a border that does not come from Carbon v11 Box border color should only use surface/border tokens Border color is not from Carbon v11 🔧 Update needed
N/A Box not adhering to [Carbon] guidelines N/A 🚫 Remove – likely a holdover from previous build
A non-Carbon v11 component Not created using Carbon Components/Tokens [Unclear if we need this]  TBD
N/A Use relevant Carbon component N/A 🚫 Remove – likely a holdover from previous build

On hold messages

Logic Updated message Update
A detached Carbon v11 component This Carbon v11 component is detached ⚠️ Pending dev exploration
A Carbon v10 component from the All themes library This is a v10 component. Please update to the v11 library 🚫 Processing would be slowed by scanning four libraries

@RichKummer RichKummer moved this from In progress to In review 👀 in Carbon for IBM Products Oct 7, 2024
@RichKummer RichKummer moved this from 🏗 In Progress to ✅ Done in Design System Oct 8, 2024
@RichKummer RichKummer moved this from In review 👀 to Done 🚀 in Carbon for IBM Products Oct 8, 2024
@RichKummer RichKummer closed this as completed by moving to ✅ Done in Design System Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Archived in project
Development

No branches or pull requests

1 participant