Skip to content

Commit

Permalink
chore: update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinVandy committed Dec 31, 2023
1 parent 43f22c9 commit d17a62b
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Before proceeding with development, ensure you match one of the following criter
- Auto-build and auto-test files as you edit by running `pnpm dev`
- Implement your changes and tests
- To run examples, follow their individual directions. Usually this includes:
- Installing dependencies with `pnpm install`
- Starting the dev server with `pnpm start`
- Installing dependencies with `pnpm install` (from the root directory of the workspace)
- Starting the dev server with `pnpm start` (from the example directory)
- To test in your own projects:
- Build/watch for changes with `pnpm build`/`pnpm dev`
- Document your changes in the appropriate documentation website markdown pages
Expand All @@ -48,6 +48,5 @@ Before proceeding with development, ensure you match one of the following criter
- Update the new example's package.json to match the new example name and any other details
- Check dependencies for unused packages
- Install any additional packages to the example that you may need
- Add the example to the workspace packages array in `package.json`
- Add the example to the `tsconfig.json` file for type checking
- Commit the example eg. `examples: Add example-name`
- Update the docs/config.json file to include the new example in the navigation sidebar
- Commit the example eg. `docs: Add example-name`

0 comments on commit d17a62b

Please sign in to comment.