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

Accessibility Review #225

Open
spaceninja opened this issue Sep 21, 2020 · 0 comments
Open

Accessibility Review #225

spaceninja opened this issue Sep 21, 2020 · 0 comments
Labels
a11y This is concerning accessibility good first issue Good for newcomers help wanted Extra attention is needed

Comments

@spaceninja
Copy link
Member

spaceninja commented Sep 21, 2020

Now that we have Storybook, there's a really useful task that just about anyone can do to help the project: run an accessibility audit. It's easier than it sounds. Here's how:

From the pattern library site, review each component example. Make sure you're in "Canvas" view, and you should see the Accessibility review toolbar at the bottom of your screen. Create a new github issue for each accessibility problem you find.

Screen Shot 2020-10-07 at 2 50 03 PM

For example, here's a screenshot of the Feature List component. You can see that there's a contrast issue with the text on the green button. You can create a new issue, something like this:

Feature List Component: Contrast Issue

Ensures the contrast between foreground and background colors meets WCAG 2 AA contrast ratio thresholds

Elements must have sufficient color contrast

.label-success: Serious: Element has insufficient color contrast of 2.36 (foreground color: #0caf8b, background color: #b9ff8d, font size: 7.5pt (10px), font weight: normal). Expected contrast ratio of 4.5:1

.label-warning: Serious: Element has insufficient color contrast of 1.72 (foreground color: #ff9600, background color: #ffe466, font size: 7.5pt (10px), font weight: normal). Expected contrast ratio of 4.5:1

Then add the "a11y" label to the issue.

(In this case, the problem is actually in the Button component, but I don't expect the person who does this audit to track down the source of every problem. Just create issues for each problem you find, and someone else can take care of finding the source of the problem)

The definition of done for this issue is when the audit has reviewed all the components and creates issues for all the problems found.

@spaceninja spaceninja added the a11y This is concerning accessibility label Sep 21, 2020
@spaceninja spaceninja added good first issue Good for newcomers help wanted Extra attention is needed labels Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y This is concerning accessibility good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant