Skip to content

docs: document the visual regression suite - #375

Merged
Glittersup merged 4 commits into
TricklePay:mainfrom
trust01-ctrl:fix/issue-332-document-the-visual-regression-suite
Oct 4, 2026
Merged

Glittersup merged 4 commits into
TricklePay:mainfrom
trust01-ctrl:fix/issue-332-document-the-visual-regression-suite

Conversation

@trust01-ctrl

Copy link
Copy Markdown
Contributor

Overview

This PR documents the existing visual regression suite so contributors understand what it captures, when and how to update a snapshot deliberately, and why snapshots must never be updated just to silence a failure. It adds a dedicated docs/visual-regression.md guide, links it from the docs index and the e2e README, and adds a short pointer in CONTRIBUTING.md.

Related Issue

Changes

📝 Visual Regression Documentation

  • [ADD] docs/visual-regression.md

    • Explains what the visual suite covers (which screens/components are captured and what a snapshot represents).
    • Describes how to run the suite and how to review a visual diff.
    • States the deliberate process for updating a snapshot, including reviewing the diff before accepting it.
    • Warns against updating snapshots to silence a failure, and explains what to do instead (investigate the regression, fix the cause, or raise it for review).
  • [MODIFY] docs/README.md

    • Adds a link to the new visual regression guide so it is discoverable from the docs index.
  • [MODIFY] e2e/README.md

    • Points readers to docs/visual-regression.md for snapshot coverage, update, and review guidance.
  • [MODIFY] CONTRIBUTING.md

    • Adds a short note directing contributors to the visual regression docs before changing or updating snapshots.

Verification Results

npm run lint
✅ passed

npm run typecheck
✅ passed

npm test
✅ passed

npm run build
✅ passed
Acceptance Criteria Status
The documentation explains what the visual suite covers ✅ docs/visual-regression.md describes the captured screens/components and what snapshots represent
It states how to update a snapshot deliberately ✅ Documented run + review + update flow with diff inspection before accepting
It warns against updating snapshots to silence a failure ✅ Explicit warning with the correct investigation-first workflow

Closes #332

@drips-wave

drips-wave Bot commented Sep 30, 2026

Copy link
Copy Markdown

@trust01-ctrl Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@drips-wave drips-wave Bot mentioned this pull request Oct 3, 2026
3 tasks
@Glittersup
Glittersup merged commit 9dd310f into TricklePay:main Oct 4, 2026
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.

Document the visual regression suite

2 participants