Update contributing guide to mention snapshot test updating #8185
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
7 Ignored Deployments
|
turbo-orchestrator
bot
added
needs: triage
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @timneutkens and the rest of your teammates on |
🟢 Turbopack Benchmark CI successful 🟢Thanks |
kdy1
approved these changes
May 21, 2024
🟢 CI successful 🟢Thanks |
mehulkar
approved these changes
May 21, 2024
timneutkens
deleted the
05-21-update_contributing_guide_to_mention_snapshot_test_updating
branch
timneutkens
added a commit
to vercel/next.js
that referenced
this pull request
May 26, 2024
## What? Update: Implemented a feature in Turbopack for `typeof window` inlining: vercel/turbo#8211. Verified the changes in that PR + this PR fix the test 💯 Turbopack upgrade: * vercel/turbo#8081 <!-- Alexander Lyon - add support for upload speed / remaining in the cache upload step --> * vercel/turbo#7673 <!-- Alexander Lyon - [turbo-trace] add additional filter modes for allocs over time --> * vercel/turbo#8191 <!-- Will Binns-Smith - Turbopack: Register react refresh exports in module factory --> * vercel/turbo#8195 <!-- Donny/강동윤 - feat: Remove lint for `grid-template-areas`" --> * vercel/turbo#8207 <!-- Benjamin Woodruff - chore: Remove unused `base16` dependency and dead `hex` wrapper function --> * vercel/turbo#8185 <!-- Tim Neutkens - Update contributing guide to mention snapshot test updating --> * vercel/turbo#8211 <!-- Tim Neutkens - Add option for inlining typeof window --> * vercel/turbo#8214 <!-- Will Binns-Smith - Revert "Turbopack: Register react refresh exports in module factory (#8191)" --> --- Previous PR description:: Implements a failing test for issue #66058. The test only fails when using Turbopack. While digging into that issue I found that `typeof window` replacement is either not applied or does not cause `import()` or `require()` to be removed. In the reproduction that approach is used to load a particular package only in Node.js and another only in the browser. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Had to ask this info from the rest of the team, ensures it's documented.
Testing Instructions