Skip to content

Add testing guidance on snapshots and waitFor to AGENTS.md - #5885

Merged
Eugene (OEvgeny) merged 2 commits into
mainfrom
OEvgeny/dev-agents-md-testing-guidance
Oct 17, 2026
Merged

Eugene (OEvgeny) merged 2 commits into
mainfrom
OEvgeny/dev-agents-md-testing-guidance

Conversation

@OEvgeny

Copy link
Copy Markdown
Collaborator

Changelog Entry

Not required, development only.

Description

Two testing practices that came up repeatedly in recent reviews are not in AGENTS.md, so agents keep missing them:

This PR adds one bullet for each to "Testing instructions".

Specific Changes

  • AGENTS.md: two bullets under "Testing instructions": let snapshots verify visual changes and assert state instead of computed CSS; wait for asynchronous effects with waitFor() from @testduet/wait-for

  • I have added tests and executed them locally

  • I have updated CHANGELOG.md

  • I have updated documentation

Review Checklist

This section is for contributors to review your work.

  • Accessibility reviewed (tab order, content readability, alt text, color contrast)
  • Browser and platform compatibilities reviewed
  • CSS styles reviewed (minimal rules, no z-index)
  • Documents reviewed (docs, samples, live demo)
  • Internationalization reviewed (strings, unit formatting)
  • package.json and package-lock.json reviewed
  • Security reviewed (no data URIs, check for nonce leak)
  • Tests reviewed (coverage, legitimacy)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Both additions match the referenced testing guidance and change no runtime behavior.

No open issues 🎉

What changed in this PR

Documents two testing practices in AGENTS.md to improve visual checks and reduce flaky asynchronous assertions.

Changes:

  • Prefer snapshots for visual verification and assertions for state.
  • Use waitFor() with expect for asynchronous effects instead of sleeps.
File Description
AGENTS.md Adds snapshot and asynchronous assertion guidance.

Review effort: Balanced

@OEvgeny
Eugene (OEvgeny) enabled auto-merge (squash) October 17, 2026 07:32
@OEvgeny
Eugene (OEvgeny) enabled auto-merge (squash) October 17, 2026 07:45
@OEvgeny
Eugene (OEvgeny) merged commit 93aac51 into main Oct 17, 2026
32 checks passed
@OEvgeny
Eugene (OEvgeny) deleted the OEvgeny/dev-agents-md-testing-guidance branch October 17, 2026 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants