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

chore: update CONTRIBUTING.md #16465

Merged
merged 3 commits into from Apr 30, 2024
Merged

Conversation

btea
Copy link
Collaborator

@btea btea commented Apr 19, 2024

Description

If vite is not built before executing pnpm run docs, an error will occur in twoslash.

Copy link

stackblitz bot commented Apr 19, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@bluwy
Copy link
Member

bluwy commented Apr 29, 2024

I don't think we should force a Vite build before starting the docs as it will take awhile. Since the twoslash errors is not breaking the dev server, I think it should be enough to update CONTRIBUTING.md about the need to do a full build to get the twoslash ready.

@btea
Copy link
Collaborator Author

btea commented Apr 29, 2024

Makes sense. 👍

@btea btea changed the title chore: update docs script chore: update CONTRIBUTING.md Apr 30, 2024
@@ -166,7 +174,7 @@ For a mock dependency, make sure you add a `@vitejs/test-` prefix to the package

## Debug Logging

You can set the `DEBUG` environment variable to turn on debugging logs (e.g. `DEBUG="vite:resolve"`). To see all debug logs, you can set `DEBUG="vite:*"`, but be warned that it will be quite noisy. You can run `grep -r "createDebugger('vite:" packages/vite/src/` to see a list of available debug scopes.
You can set the `--debug` option to turn on debugging logs (e.g. `vite --debug resolve`). To see all debug logs, you can set `vite --debug *`, but be warned that it will be quite noisy. You can run `grep -r "createDebugger('vite:" packages/vite/src/` to see a list of available debug scopes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Refer to #16144

CONTRIBUTING.md Outdated Show resolved Hide resolved
@patak-dev patak-dev merged commit 8c6d4be into vitejs:main Apr 30, 2024
11 checks passed
@btea btea deleted the chore/update-docs-script branch April 30, 2024 08:14
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.

None yet

3 participants