Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

Commit 3abc7f5

Browse files
docs(contributing): update file
- remove 4 step in initial setup (not needed in this section) - remove mention of NODE_ENV for Windows user (was fixed in PR #172) - add link to `components-guide` for new component building - mention running `yarn start` before starting the playground server
1 parent f5742e5 commit 3abc7f5

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@ yarn
2424
# After the dependencies are installed, the `postinstall` script with trigger `preconstruct dev` which will build all the component packages.
2525
```
2626

27-
4. Run the Vite Playground.
28-
```
29-
yarn playground:dev
30-
```
31-
This will boot the playground server and watches for changes in any package.
32-
3327
> If you run into any issues during these steps, kindly reach out to the Chakra UI
3428
> Vue team here:[https://discord.gg/cMpMfvxa](https://discord.gg/cMpMfvxa)
3529
@@ -38,14 +32,15 @@ There may be some trouble specific to the local setup in Windows. The following
3832

3933
- The package dependencies and scripts should work with Node `v16.16.0 and higher`
4034
- If you receive the error `EPERM: operation not permitted, symlink` and mentions `preconstruct`, you will need to enable OS developer mode. See Github issue [#381 for Preconstruct](https://github.com/preconstruct/preconstruct/issues/381)
41-
- If you receive the error `NODE_ENV is not recognized as an internal or external command`, try the package [win-node-env](https://www.npmjs.com/package/win-node-env)
4235

4336
## Development
4437

4538
To improve our development process, we've set up tooling and systems. Chakra UI
4639
uses a monorepo structure and we treat each component as an independent package
4740
that can be consumed in isolation.
4841

42+
If you are looking to build a new component, and it has been approved by the team, head over to the [components-guide.md](./docs/guides/component-guide.md) to help you get started!
43+
4944
### Tooling
5045

5146
- [Lerna](https://lerna.js.org/) to manage installation of dependencies and
@@ -120,6 +115,8 @@ docs, simply run `yarn build`, and `yarn docs:dev`
120115

121116
Build components in isolation with Vite using `yarn playground:dev`
122117

118+
Run `yarn start` in a separate terminal first so the packages are built and a watcher set up for changes.
119+
123120
## Think you found a bug?
124121

125122
Please conform to the issue template and provide a clear path to reproduction

0 commit comments

Comments
 (0)