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

Missmatch between default rules documentation? #907

Closed
molant opened this issue May 21, 2018 · 5 comments · Fixed by #931
Closed

Missmatch between default rules documentation? #907

molant opened this issue May 21, 2018 · 5 comments · Fixed by #931
Labels
docs Documentation changes

Comments

@molant
Copy link

molant commented May 21, 2018

Hello all,

in sonarwhal we are using aXe's default options. Per the documentation we thought that we were running only the WCAG 2.0 Level A and Level AA rules:

The default operation for axe.run is to run all WCAG 2.0 Level A and Level AA rules. If certain rules should be disabled from being run, specify options as:

@aardrian brought us to at attention that this might not be the case in this issue and looking into the rule descriptions it looks like there are more rules running by default.

Can you please confirm what set of rules is being run?

Thanks!

@marcysutton
Copy link
Contributor

The rule-descriptions are accurate. If you look at the tags in that file, some of them are best practices. @WilcoFiers I think the docs didn't get updated when best practices were enabled by default.

From API.md:

The default operation for axe.run is to run all WCAG 2.0 Level A and Level AA rules.

That begs a larger question, should best practices be turned on by default?

@aardrian
Copy link

That begs a larger question, should best practices be turned on by default?

For those who may be using it for assessing legal compliance, must statements (in particular) can imply a legal requirement and drain resources from addressing issues that are truly legal risks (real WCAG issues).

Since not all tools that lean on default settings may surface those you have flagged as best practices, it might be safer to leave them off by default.

@WilcoFiers
Copy link
Contributor

Good point about the docs. I do think Axe-core should run with best practices enabled by default. The most common use of Axe-core is developers using it during feature development. That is where best practices should be used. For compliance best practices should be turned off.

@darekkay
Copy link

Just to be sure - this decision was changed with axe-core 4.0, correct? From the new docs

The default operation for axe.run is to run all rules except for rules with the "experimental" tag

@straker
Copy link
Contributor

straker commented Oct 26, 2020

I don't think anything has changed about which rules run in 4.0. Since at least 3.0 axe runs all rules except experimental, and that continues through 3.0.

The only axe tool that runs experimental rules is axe-coconut.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants