a11y-自动化

目录

• 简介
• 开始使用
• 贡献
• 问题、建议或疑虑

本应用正在开发中；欢迎改进和协作。

简介

该应用旨在跟踪以下几个方面：

• 潜在的违规；即应用可能违反数字无障碍成功标准的具体方式（在本应用中称为violations）
• 每个违规可用的自动化代码检查方法
• 每个违规可用的自动化测试方法
• 如果需要，手动测试方法
• 本应用的样式主要由Tailwind提供。

这是一个Ember应用，这意味着你需要安装Ember（npm install -g ember-cli）才能贡献。欢迎各种形式的贡献：

• 提交bug
• 提交新功能请求
• 提交PR以解决问题、改进样式或添加新功能
• 改进README或其他文档
• 添加艺术/图形

已评估易于贡献的问题将带有pr-welcome标签，但如果你有信心作为专业人士参与，请尽管参与！符合项目目标的PR将会被审核。

开始使用

要在本地使用此应用，请按以下步骤操作：

1. 克隆仓库：git clone https://github.com/MelSumner/a11y-automation.git
2. 切换到应用目录：cd a11y-automation
3. 安装缺失的依赖：yarn
4. 构建应用：yarn start
5. 在你选择的浏览器中访问http://localhost:4200/。

贡献

要为此项目做出贡献，请遵循我们的贡献指南。

要向应用添加资源（如图像或字体），请将它们放在public文件夹的适当子文件夹中。

添加数据

本应用中的数据以单独的.md文件形式存储，然后自动转换为.json以在应用中使用。这使得添加新的规则项或标签变得相当简单——只需添加一个.md文件即可！此外，还创建了一些生成器来简化此过程。（想看看自动转换的实际效果吗？在本地启动应用后，访问http://localhost:4200/violations/all.json查看编译后的JSON输出！很酷，对吧？）

添加新的违规

要添加新文件以跟踪潜在的a11y违规，你可以手动将文件添加到violations文件夹，或使用生成器生成文件并将其放在正确的位置——ember generate violations rule-name，其中rule-name是要添加的规则名称。注意：除非事先协调，否则每个拉取请求应仅提交一个新文件。

添加新标签

要添加新的标签文件，你可以手动将文件添加到tags文件夹，或从命令行使用生成器文件：ember generate tags tag-name，其中tag-name是标准的短横线连接版本。例如，WCAG 1.1.1变为wcag-1-1-1，完整命令如下：ember generate tags wcag-1-1-1。除非事先协调，否则每个拉取请求应仅生成一个标签文件。

问题、建议或疑虑

如果你有任何问题、建议或疑虑，最好的解决方式是在此仓库上提出问题，我会尽快回复。我还会尝试列出我已经被问到的问题，以防你也在想同样的问题。

文档中的包含

虽然此应用目前跟踪ember-template-lint的代码检查和axe-core的测试，但我们已扩展支持以包括其他JavaScript框架的代码检查。如果你想为其他框架贡献代码检查支持，请遵循现有违规中的格式，以便你的PR更容易被接受/合并。