Skip to content

docs: add comprehensive manual testing guide for VSCode extension#37

Merged
Patrick-Ehimen merged 1 commit intomainfrom
docs/vscode-extension-testing
Dec 1, 2025
Merged

docs: add comprehensive manual testing guide for VSCode extension#37
Patrick-Ehimen merged 1 commit intomainfrom
docs/vscode-extension-testing

Conversation

@Patrick-Ehimen
Copy link
Copy Markdown
Owner

@Patrick-Ehimen Patrick-Ehimen commented Nov 15, 2025

  • Added detailed test cases for all extension features
  • Included setup instructions and prerequisites
  • Documented error scenarios and edge cases
  • Added performance and regression testing guidelines
  • Included platform-specific testing checklist
  • Provided troubleshooting and reporting guidelines

Summary by Sourcery

Add a comprehensive manual testing guide for the Lighthouse VSCode extension, detailing setup, test cases, performance and regression checklists, platform compatibility, troubleshooting, and reporting procedures.

Documentation:

  • Add setup and prerequisite instructions for building and installing the extension
  • Document 15 manual test scenarios covering activation, configuration, file and dataset operations, UI interactions, error handling, progress tracking, and multi-root workspaces
  • Include performance testing procedures, regression testing checklist, and platform-specific testing matrix
  • Provide troubleshooting tips, issue reporting guidelines, automated testing recommendations, and a quick smoke-test script

- Added detailed test cases for all extension features
- Included setup instructions and prerequisites
- Documented error scenarios and edge cases
- Added performance and regression testing guidelines
- Included platform-specific testing checklist
- Provided troubleshooting and reporting guidelines
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Nov 15, 2025

Reviewer's Guide

Introduces a comprehensive manual testing guide for the VSCode extension, covering setup prerequisites, detailed feature test cases, performance and regression checklists, platform-specific tests, and troubleshooting/reporting guidelines.

File-Level Changes

Change Details Files
Add manual testing guide scaffold and setup instructions
  • Introduced prerequisites section (VSCode version, Node.js, API key)
  • Outlined build and install methods (dev host and VSIX)
  • Provided initial guide structure and overview
packages/vscode-extension/MANUAL_TESTING.md
Embed detailed testing and support guidelines
  • Defined step-by-step test cases for activation, API key, commands, file/dataset operations, UI interactions, error handling, and multi-workspace
  • Added sections for performance testing, regression checklist, platform-specific testing, and automated tests
  • Included troubleshooting, reporting, quick test script, and effective testing tips
packages/vscode-extension/MANUAL_TESTING.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Patrick-Ehimen Patrick-Ehimen merged commit 0784163 into main Dec 1, 2025
1 check passed
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.

1 participant