{"id":15015820,"url":"https://github.com/melsumner/a11y-automation","last_synced_at":"2025-05-16T13:05:38.281Z","repository":{"id":39098109,"uuid":"303168565","full_name":"MelSumner/a11y-automation","owner":"MelSumner","description":"Open-source project. Tracking the available automation for accessibility. What a11y failures can be linted \u0026 tested for in an automated fashion?","archived":false,"fork":false,"pushed_at":"2025-01-31T14:07:30.000Z","size":8345,"stargazers_count":242,"open_issues_count":30,"forks_count":33,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-09T08:06:09.876Z","etag":null,"topics":["a11y","ember","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://a11y-automation.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MelSumner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"MelSumner"}},"created_at":"2020-10-11T16:52:32.000Z","updated_at":"2025-02-10T22:40:12.000Z","dependencies_parsed_at":"2022-08-09T10:17:03.552Z","dependency_job_id":"2ba4a3ce-7225-4821-a5aa-414c37cf1f00","html_url":"https://github.com/MelSumner/a11y-automation","commit_stats":{"total_commits":600,"total_committers":34,"mean_commits":"17.647058823529413","dds":0.625,"last_synced_commit":"73616ea50a8713af01139f90da88034b8cd8b54c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MelSumner%2Fa11y-automation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MelSumner%2Fa11y-automation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MelSumner%2Fa11y-automation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MelSumner%2Fa11y-automation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MelSumner","download_url":"https://codeload.github.com/MelSumner/a11y-automation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247999859,"owners_count":21031046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11y","ember","hacktoberfest"],"created_at":"2024-09-24T19:47:59.983Z","updated_at":"2025-05-16T13:05:38.275Z","avatar_url":"https://github.com/MelSumner.png","language":"JavaScript","funding_links":["https://github.com/sponsors/MelSumner"],"categories":[],"sub_categories":[],"readme":"# A11y Automation\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/f7a9f162-0916-4ff3-8ecd-2047e26a6923/deploy-status)](https://app.netlify.com/sites/a11y-automation-tracker/deploys)\n\nYou are welcome to use and/or reference this project in any derivative work.\nPlease include a reference to this project's repository if you do that.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Contributing](#contributing)\n  - [How to add data](#how-to-add-data)\n  - [Styling Conventions](#styling-conventions)\n- [Getting Started](#getting-started)\n- [Questions, Suggestions, or Concerns](#questions-suggestions-or-concerns)\n\n## Introduction\n\nThe app aims to track a few things:\n\n- potential violations; that is, specific ways an app could fail digital accessibility success criteria (called `violations` in this app)\n- automated linting methods available for each violation\n- automated testing methods available for each violation\n- whether or not an author-provided test should be written\n- manual testing methods, if they are required\n\nWe track these things through the sources we have found and know about:\n\n- [axe-core](https://github.com/dequelabs/axe-core)\n- Ember: [ember-template-lint](https://github.com/ember-template-lint/ember-template-lint)\n- Lit: [eslint-plugin-lit-a11y](https://github.com/open-wc/open-wc/blob/master/docs/docs/linting/eslint-plugin-lit-a11y/)\n- React (JSX): [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)\n- Vue: [eslint-plugin-vuejs-accessibility](https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility)\n\nDo you know about other automation tools that could be reviewed for inclusion?\nPlease let us know by filing an issue.\n\n## Contributing\n\nFirst and foremost, be kind. Please read through our [code of conduct](CODE_OF_CONDUCT.md) just so there is no misunderstanding.\n\nContributions are welcome in this open-source project. There are many different ways that anyone can contribute:\n\n- filing issues to report bugs\n- filing issues to request new features\n- filing issues to let us know about libraries that have automated rule checks that we don't already know about\n- opening a PR to resolve an issue\n- opening a PR to add a test\n- opening a PR to improve documentation (maybe something is worded incorrectly, incompletely, or just awkwardly)\n- opening a PR to add information about a non-overlay, automated tool that we haven't included yet\n\n### How to add data\n\nThe data in this app is stored as individual `.md` files.\nThis makes it fairly straightforward to add a new rule item or tag-- it's done by adding a single `.md` file to the appropriate folder.\n\nThere are three places where data can be added:\n\n1. Violations (`violations`)\n2. Tags (`tags`)\n3. Automated Tools (`automated-tools`)\n\nLook at the existing markup in the respective folders and imitate the patterns found there.\n\n### Styling Conventions\n\nCSS Declarations should be grouped and written in the following order:\n\n1. Base styles\n2. Modifier styles\n3. State styles\n4. Media Query / Responsive styles, in ascending order of breakpoint\n\nExample:\n\n```css\n.base-selector {\n  /* base styles */\n}\n\n.base-selector--modifier {\n  /* modifier styles */\n}\n\n.base-selector:element-state {\n  /* state styles */\n}\n\n@media (min-width: 640px) {\n  .base-selector {\n    /* responsive styles */\n  }\n}\n\n@media (min-width: 960px) {\n  .base-selector {\n    /* responsive styles */\n  }\n}\n\n```\n\n## Getting Started\n\nThis site uses:\n\n- [VitePress](https://vitepress.dev/)\n- The default VitePress theme with options for customizations\n- `pnpm`\n\nTo work on this app locally, follow these steps:\n\n1. Clone the repository: `git clone https://github.com/MelSumner/a11y-automation.git`\n2. Switch to the app's directory: `cd a11y-automation`\n3. Install missing dependencies: `pnpm install`\n4. Start the app locally: `pnpm vitepress dev .`.\n5. it'll be available at `http://localhost:5173/` in your browser of choice.\n\nIf these instructions don't work for you, please let us know by filing an issue.\n\nP.S. We used to use Tailwind CSS but found that it was a blocker for some contributors. As such, any issue or PR that suggests or adds it will be closed with this explanation.\n\n## Questions, Suggestions, or Concerns\n\nIf you have any questions, suggestions or concerns, the best way to resolve them is to file an issue on this repo and I'll respond as soon as I am able.\n\nFinally, it is highly unlikely that _any_ overlay tool will ever be included in this site.\nPlease see the [Overlay Fact Sheet](https://overlayfactsheet.com/en/) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelsumner%2Fa11y-automation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmelsumner%2Fa11y-automation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelsumner%2Fa11y-automation/lists"}