Skip to content

docs: update CONTRIBUTING for Vite and current npm scripts #918

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

Merged
davidhu2000 merged 1 commit into from
Sep 28, 2026
Merged

docs: update CONTRIBUTING for Vite and current npm scripts #918

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 13 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,31 @@ Install the necessary dependencies (you can use `npm` or `yarn`):

npm install

If you want to make changes to the demo page, you can edit the files in `examples` and `docs` folder.
If you want to make changes to the demo page, you can edit the files in the `examples` folder.

To see the changes to the loaders or the demo site, you can use `webpack` to update the bundle file.
To see the changes to the loaders or the demo site, start the Vite dev server:

npm run watch
npm run dev

And open `./docs/index.html` in your favorite browser.
And open the local URL it prints in your favorite browser.

After all the changes are made, make sure nothing changed in the demo site by running
After all the changes are made, make sure the demo site still builds:

npm run build:demo

And commit the file changes in the docs folder.

Then commit your changes:
Make sure to run the necessary tests and lints and fix any errors:

git add -A;
git commit -m 'Awesome new feature';
npm run lint
npm run test

Make sure to run the necessary tests and lints and fix any errors:
Then commit your changes:

npm run lint;
npm run test:jest;
git add -A
git commit -m 'Awesome new feature'

Push up to Github:
Push up to GitHub:

git push origin awesome-feature;
git push origin awesome-feature

[Create a Pull Request][pr], add appropriate label(s).

Expand Down