Skip to content

Commit d17a62b

Browse files
committedDec 31, 2023
chore: update contributing guide
1 parent 43f22c9 commit d17a62b

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed
 

‎CONTRIBUTING.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Before proceeding with development, ensure you match one of the following criter
3333
- Auto-build and auto-test files as you edit by running `pnpm dev`
3434
- Implement your changes and tests
3535
- To run examples, follow their individual directions. Usually this includes:
36-
- Installing dependencies with `pnpm install`
37-
- Starting the dev server with `pnpm start`
36+
- Installing dependencies with `pnpm install` (from the root directory of the workspace)
37+
- Starting the dev server with `pnpm start` (from the example directory)
3838
- To test in your own projects:
3939
- Build/watch for changes with `pnpm build`/`pnpm dev`
4040
- Document your changes in the appropriate documentation website markdown pages
@@ -48,6 +48,5 @@ Before proceeding with development, ensure you match one of the following criter
4848
- Update the new example's package.json to match the new example name and any other details
4949
- Check dependencies for unused packages
5050
- Install any additional packages to the example that you may need
51-
- Add the example to the workspace packages array in `package.json`
52-
- Add the example to the `tsconfig.json` file for type checking
53-
- Commit the example eg. `examples: Add example-name`
51+
- Update the docs/config.json file to include the new example in the navigation sidebar
52+
- Commit the example eg. `docs: Add example-name`

0 commit comments

Comments
 (0)