[#829] Update Project README #831
Merged
Conversation
This file contains 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
- Remove mention of react-a11y from the file - Add recommendation to use jsx-a11y together with @axe-core/react - Add recommendation to complement automated tools with manual testing Fixes jsx-eslint#829.
Codecov Report
@@ Coverage Diff @@
## main #831 +/- ##
=======================================
Coverage 99.22% 99.22%
=======================================
Files 98 98
Lines 1419 1419
Branches 479 479
=======================================
Hits 1408 1408
Misses 11 11 Continue to review full report at Codecov.
|
ljharb
approved these changes
Feb 15, 2022
Comment on lines
+130
to
+131
| | Rule | Recommended | Strict | | ||
| | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------ | |
There was a problem hiding this comment.
in a followup, we should probably change all these tables to be autogenerated - see https://github.com/yannickcr/eslint-plugin-react for one way to do it.
ljharb
force-pushed
the
pr/readme-update
branch
from
0c36b3e
to
f878d3b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR adds updates to the project readme. It removes a mention of deprecated
react-a11yfrom the file and adds a recommendation to usejsx-a11ytogether with@axe-core/reactas well as complement automated accessibility testing with manual testing.Related Issue
Closes #829
Acceptance Criteria
react-a11yjsx-a11ytogether with@axe-core/reactType of Changes