diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15378b0e..030ac8ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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).