Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rearrange browser guide #5799

Merged

Conversation

MatanBobi
Copy link
Contributor

Description

Following the idea to create an init command for browser mode (#5793), I suggested updating the doc page in the meanwhile to help people onboard more easily.
I rearranged the doc page a bit and added install commands as I think the motivation and drawbacks are less important for someone who navigates to this page as they're probably looking for an actionable checklist.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@sheremet-va sheremet-va merged commit fe3190d into vitest-dev:main Jun 3, 2024
16 checks passed
@MatanBobi
Copy link
Contributor Author

Thanks for merging this @sheremet-va.
Is the first comment there correct? I received an error due to the fact I didn't have webdriverio installed.

@sheremet-va
Copy link
Member

Thanks for merging this @sheremet-va. Is the first comment there correct? I received an error due to the fact I didn't have webdriverio installed.

The default will be changed: #5826

@MatanBobi
Copy link
Contributor Author

The default will be changed: #5826

Nice, thanks for the quick answer :)

@MatanBobi MatanBobi deleted the docs/re-arrange-browser-guide branch June 3, 2024 10:51
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