Improve UI Coverage noise reduction docs for non-developer QA teams#6482
Open
jennifer-shehane wants to merge 10 commits into
Open
Improve UI Coverage noise reduction docs for non-developer QA teams#6482jennifer-shehane wants to merge 10 commits into
jennifer-shehane wants to merge 10 commits into
Conversation
Expands ignore-elements guide with concrete real-world examples (sidebar, grid filter icons, third-party widgets), clearer step-by-step instructions, and guidance on preserving visibility into new elements while filtering noise. Rewrites reduce-noise guide to directly address the assertion-only test coverage gap: adds a new section explaining why layout verification tests show as uncovered, and shows how to use allowedInteractionCommands with "assert" to count .should() assertions as valid coverage for read-only and display elements. Adds a decision table to help teams choose between asserting, ignoring, or leaving an element as a real coverage gap. https://claude.ai/code/session_01Xtiy2kq1g74G7Jt9Qsugku
…generic Sidebars and menus are valid coverage targets and shouldn't be recommended for blanket exclusion. Third-party widget examples now use generic placeholder selectors with a note to use DevTools to find the real selector, rather than hardcoding library-specific class names like .ag-filter-icon or #intercom-container. https://claude.ai/code/session_01Xtiy2kq1g74G7Jt9Qsugku
…ments Lead with the primary use case from the blog post: container divs, overlays, and shadow shields that capture clicks but aren't real user-facing controls. Add Test Replay as the workflow for identifying wrapper elements. Add filter order guidance (specific before general). Remove the trailing comparison table in favor of inline validation steps that check both tested and untested sections. https://claude.ai/code/session_01Xtiy2kq1g74G7Jt9Qsugku
…om/cypress-io/cypress-documentation into claude/ui-coverage-skip-docs-kVgRA
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
claude/ui-coverage-skip-docs-kVgRA
|
| Run status |
|
| Run duration | 06m 00s |
| Commit |
|
| Committer | Jennifer Shehane |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
|
|
0
|
|
|
0
|
|
|
0
|
|
|
0
|
|
|
323
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
47.37%
|
|
|---|---|
|
|
340
|
|
|
3
|
Accessibility
96.89%
|
|
|---|---|
|
|
1 critical
3 serious
4 moderate
1 minor
|
|
|
38
|
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
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.
Expands ignore-elements guide with concrete real-world examples (sidebar,
grid filter icons, third-party widgets), clearer step-by-step instructions,
and guidance on preserving visibility into new elements while filtering noise.
Rewrites reduce-noise guide to directly address the assertion-only test
coverage gap: adds a new section explaining why layout verification tests
show as uncovered, and shows how to use allowedInteractionCommands with
"assert" to count .should() assertions as valid coverage for read-only
and display elements. Adds a decision table to help teams choose between
asserting, ignoring, or leaving an element as a real coverage gap.
https://claude.ai/code/session_01Xtiy2kq1g74G7Jt9Qsugku
Note
Low Risk
Changes are limited to documentation MDX files with no runtime, API, or configuration behavior changes.
Overview
Documentation-only updates to two UI Coverage guides aimed at QA teams who need clearer, actionable guidance on report noise.
ignore-elements.mdxreframes the guide around wrapper noise and third-party widgets, adds a caution on over-broad filters hiding new elements, and restructures content into identify → configure → validate steps with Test Replay and Untested-elements workflows. JSON examples are replaced/expanded (submenu overlays, chat widget + auth iframe, optionaldata-uic-ignoremarkup) plus filter ordering and post-change validation (includingdocument.querySelectorAll).reduce-noise.mdxadds a major section on assertion-only / layout verification tests: why.should()does not count as tested by default, how to useuiCoverage.allowedInteractionCommandswith"assert"(with examples and a caution that rules replace defaults), and a decision table (assert vs filter vs real gap). Existing view/element grouping and attribute sections are tightened with clearer examples and updated copy (e.g.viewspattern hostnames, quoted attribute selectors inelementGroups).Reviewed by Cursor Bugbot for commit 31050d4. Bugbot is set up for automated code reviews on this repo. Configure here.