TDEAL-23: Updating visual verification documentation

[porgabi]

TDEAL-23

[coderabbitai]

Walkthrough

The updates involve guidance on maintaining visual testing accuracy. A comment has been added to remind developers to update baseline images after altering UI elements. Additionally, the exception handling for missing baseline images in visual tests has been improved by suggesting a configuration change to disable retries when generating new baseline images.

Changes

File Path	Change Summary
.../BasicVisualVerificationTests.cs	Added a comment to instruct on updating baseline images following UI changes.
.../VisualVerificationBaselineImageNotFoundException.cs	Modified exception handling to recommend setting maxRetryCount to 0 for baseline image generation when the image is missing.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit's AI:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
  • @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2aca656 and d3be0ea.

Files selected for processing (2)

• Lombiq.Tests.UI.Samples/Tests/BasicVisualVerificationTests.cs (1 hunks)
• Lombiq.Tests.UI/Exceptions/VisualVerificationBaselineImageNotFoundException.cs (1 hunks)

Files skipped from review due to trivial changes (1)

• Lombiq.Tests.UI.Samples/Tests/BasicVisualVerificationTests.cs

Additional comments: 1

Lombiq.Tests.UI/Exceptions/VisualVerificationBaselineImageNotFoundException.cs (1)

• 22-25: The updated exception message provides clear instructions based on the maxRetryCount value. When maxRetryCount is not 0, it now advises setting it to 0 to generate images, which aligns with the PR objectives to improve exception handling for visual verification. This change should help developers understand the necessary steps when a baseline image is not found.

[sarahelsaig]

Beautiful! The "walkthrough" is longer than the actual documentation added.