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(getting started): Add default test name tip #4832

Merged
merged 2 commits into from
Jan 15, 2024
Merged

docs(getting started): Add default test name tip #4832

merged 2 commits into from
Jan 15, 2024

Conversation

hogoww
Copy link
Contributor

@hogoww hogoww commented Dec 31, 2023

Description

I'm new to Vite, vitest, and JS in general.
Because I had to follow multiple tutorials, my test name was wrong, and it took me multiple hours to realize.
Coming from multiple other programing languages that works differently, and even having written some small test runners, I expected the include regex to look inside the file rather than only the file name.

I think this small tip in documentation can help neophytes to avoid that basic mistake that they can encounter for multiple reasons.

  • [-] 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.
    Only discution to be had is the format of the tip. I think this can be done in the PR directly as it is very small.
  • [ - ] Ideally, include a test that fails without this PR but passes with it.
    Documentation, no tests impacted
  • [ x ] Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.
    None

Tests

  • [ - ] Run the tests with pnpm test:ci.
    None

Documentation

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

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:.

I hope I followed everything to make this PR viable :)
Have a wonderful day !

Copy link

netlify bot commented Dec 31, 2023

Deploy Preview for fastidious-cascaron-4ded94 ready!

Name Link
🔨 Latest commit d571ecd
🔍 Latest deploy log https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/65915c5f108269000896a97c
😎 Deploy Preview https://deploy-preview-4832--fastidious-cascaron-4ded94.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hogoww hogoww changed the title docs(getting started): Add default test name tip [Quick review]docs(getting started): Add default test name tip Jan 12, 2024
@hogoww
Copy link
Contributor Author

hogoww commented Jan 12, 2024

Any reviewer around ? :)
Can't really make a quicker PR !

@sheremet-va sheremet-va changed the title [Quick review]docs(getting started): Add default test name tip docs(getting started): Add default test name tip Jan 15, 2024
@sheremet-va sheremet-va merged commit 3e6668e into vitest-dev:main Jan 15, 2024
19 checks 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.

2 participants