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

feat(a11y): add scripts for reporting a11y violations #517

Merged
merged 1 commit into from Aug 7, 2018

Conversation

seanforyou23
Copy link
Collaborator

This PR adds a few new scripts to help with identifying accessibility issues with our components. These scripts handle creating a sitemap file, which is processed by the aXe accessibility engine, which then outputs a report that can be used to guide developers on how to solve the issues being reported.

This introduces a nominal number of new dependencies, which are:

  • axe-core
  • axe-webdriverjs
  • selenium-webdriver

How to use:

  1. npm run dev
  2. In another terminal npm run a11y
  3. Notice feedback produced by reporter

We'll soon want the ability for this to run as part of a CI job, this can be completed as part of follow up work. For now, the main thing is getting this tool into our hands so we can begin chipping away at the existing problems we have.

Should help close #466

add sitemap generator script
don't track generated files
add an audit runner
add basic reporters
add script for running as part of ci

@patternfly-build
Copy link

patternfly-build commented Aug 1, 2018

Deploy preview for pf-next ready!

Built with commit d50fc4f

https://deploy-preview-517--pf-next.netlify.com

Copy link
Member

@dgutride dgutride left a comment

Choose a reason for hiding this comment

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

Like seeing the graphql usage in here - will be good to expand on that as we move forward

add sitemap generator script
stop tracking generated files
add a test/audit runner
add basic reporters
add script for running as part of ci
@dgutride dgutride merged commit c20ae4f into patternfly:master Aug 7, 2018
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.

None yet

3 participants