chore: update contributing guide vite troubleshooting #13826
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
HuiSF
changed the title
Samaritan1011001
previously approved these changes
Sep 19, 2024
jjarvisp
reviewed
Sep 19, 2024
CONTRIBUTING.md
Outdated
| @@ -126,6 +126,16 @@ In your sample project, you can now link specific packages | |||
| yarn link @aws-amplify/auth | |||
| ``` | |||
|
|
|||
| If you are testing with a Vite sample project, such as from the quickstart guide, and your changes to the library are not showing up in your local app when running `npm run dev`, Vite caching may be the culprit. Try editing this line in your sample project's `package.json`. | |||
There was a problem hiding this comment.
One recommendation, pretty much everywhere else in the contributing guide refers to using yarn as the package manager, so it's probably a good idea to keep it consistent.
There was a problem hiding this comment.
Good call out. The quickstart guide uses npm, but there is no difference in behavior. I'll add that.
scanlonp
commented
Sep 19, 2024
AllanZhengYP
approved these changes
Sep 20, 2024
jjarvisp
approved these changes
Sep 20, 2024
ashika112
approved these changes
Sep 20, 2024
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.
My library changes were not showing up in my locally deployed app. Vite caching turned out to be the issue. Add a note to help future contributors avoid this problem.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.