docs: Document how to propose axe-core rules#507
Merged
WilcoFiers merged 2 commits intodevelopfrom Sep 8, 2017
Merged
Conversation
isner
reviewed
Sep 5, 2017
| 2. If the element has an accessible name, return false | ||
| 3. Otherwise return true | ||
|
|
||
| ## Template |
Contributor
There was a problem hiding this comment.
The template is missing a section for specifying tags, which you ask the submitter to supply in the section above.
dylanb
approved these changes
Sep 5, 2017
Contributor
dylanb
left a comment
dylanb
left a comment
There was a problem hiding this comment.
I added some suggestions for improving this document and/or related documents
|
|
||
| There are two ways a rule written in the axe-core rule format can be transformed into the ACT Rules format: | ||
|
|
||
| ## Method 1: Create a single rule |
Contributor
There was a problem hiding this comment.
Best practices for rules should be added:
- Rules should only have one
nonecheck so that the error message is specific - Rules should not combine
anyandnone, these should be broken out into separate rules - Checks should each only test a single specific case (either a passing technique or a single failing test)
|
|
||
| All Github issues that propose a rule must be tagged as *rule*, and must use the following format: | ||
|
|
||
| ### Intro |
Contributor
There was a problem hiding this comment.
Should we add a section for the message that would appear if the rule fails? This is what the user will see most of the time.
Contributor
Author
marcysutton
pushed a commit
that referenced
this pull request
Sep 8, 2017
* docs: Document how to propose axe-core rules * fix(rule-proposal): Added best practice and rule help
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is designed to do a few things:
Here are a few example rules the ACT Taskforce has developed for comparison: wilcofiers.github.io/act-rules/