axe-windows/docs/FAQ.md

FAQ

Q. What is Axe.Windows?

Axe.Windows is a NuGet package for running automated accessibility tests on Windows® applications. It is used extensively by Accessibility Insights For Windows. It can be used by itself to run automated accessibility tests programmatically as well.

Q. Why should I contribute to Axe.Windows?

By contributing you will help ensure that people with disabilities have full access to applications. Make the world a better place!

Q. How do I get started?

Visit the Readme and the Overview page to get started.

For instructions on how to build the code, please visit building the code.

For an overview of the solution, please visit the solution overview.

Once you are ready to make a contribution visit the Contributions page.

Q. Where can I download the package?

to get the latest version of the Axe.Windows NuGet package, visit Axe.Windows on NuGet.org.

Q. How can I add or change an automated accessibility test?

Before adding or changing an automated test, please read the Rules Overview. The page provides essential information about working inside the Rules project.

Q. How do I go about adding unit tests?

Please follow the guidelines outline in the Adding Unit Tests page.

Q. Where can I find the standards for unit tests?

Standards have been documented on Unit Test Bar and Standards.

Q. Why do I sometimes see delays when running the CLI locally or running unit tests?

This may be a result of your local virus scanner. Virus Scanner Exclusions provides more information.

Q. How do I go about making internal interfaces available for testing?

Please visit Accessing Internals.

Q. What happens after I submit a pull request?

All pull requests initiate a build. The build status is visible in the PR checks section. Failures need to be addressed before the PR can be merged.

Q.How do I go about adding telemetry for my changes?

Please visit the Telemetry page on how to do so.

Q. How do I add a project to the solution?

Visit Adding a new project for instructions.

For an overview of the solution, please visit the solution overview.

q. On my pull request, the "license/cla" check does not complete. What should I do?

Make sure that you have signed our CLA agreement. If you haven't, please sign the agreement, then close and reopen the PR. This will trigger a new build with the CLA agreement in place.

Q. How do I get in contact?

Please file a Github Issue. We actively monitor pull requests and issues.

Q. I encountered a bug. Where do I report it?

We use Github Issues for bug tracking.

Visit the issues page to see if an issue for it already exists.

If it doesn't, feel free to file an issue.