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.

Sign up for GitHub

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

Jump to bottom

chore: update contributing guide vite troubleshooting #13826

Merged
merged 3 commits into from
Oct 14, 2024
Merged

chore: update contributing guide vite troubleshooting #13826

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7980db
docs: update contributing guide vite troubleshooting
scanlonp Sep 18, 2024
00dc1fa
Update CONTRIBUTING.md
scanlonp Sep 19, 2024
9bf98e9
Merge branch 'main' into patch-1
AllanZhengYP Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call out. The quickstart guide uses npm, but there is no difference in behavior. I'll add that.

scanlonp marked this conversation as resolved.
Show resolved Hide resolved

```diff
"scripts": {
- "dev": "vite",
+ "dev": "vite --force",
...
}
```

Passing unit tests are only necessary if you’re looking to contribute a pull request. If you’re just playing locally, you don’t need them. However, if you’re contributing a pull request for anything other than making a change to the documentation, fixing a formatting issue in the code (i.e., white space, missing semi-colons) or another task that does not impact the functionality of the code, you will need to validate your proposed changes with passing unit tests.

#### Verdaccio
Expand Down
Loading