You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 20, 2024. It is now read-only.
- 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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-7Lines changed: 4 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,12 +24,6 @@ yarn
24
24
# After the dependencies are installed, the `postinstall` script with trigger `preconstruct dev` which will build all the component packages.
25
25
```
26
26
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
-
33
27
> If you run into any issues during these steps, kindly reach out to the Chakra UI
34
28
> Vue team here:[https://discord.gg/cMpMfvxa](https://discord.gg/cMpMfvxa)
35
29
@@ -38,14 +32,15 @@ There may be some trouble specific to the local setup in Windows. The following
38
32
39
33
- The package dependencies and scripts should work with Node `v16.16.0 and higher`
40
34
- 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)
42
35
43
36
## Development
44
37
45
38
To improve our development process, we've set up tooling and systems. Chakra UI
46
39
uses a monorepo structure and we treat each component as an independent package
47
40
that can be consumed in isolation.
48
41
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
+
49
44
### Tooling
50
45
51
46
-[Lerna](https://lerna.js.org/) to manage installation of dependencies and
@@ -120,6 +115,8 @@ docs, simply run `yarn build`, and `yarn docs:dev`
120
115
121
116
Build components in isolation with Vite using `yarn playground:dev`
122
117
118
+
Run `yarn start` in a separate terminal first so the packages are built and a watcher set up for changes.
119
+
123
120
## Think you found a bug?
124
121
125
122
Please conform to the issue template and provide a clear path to reproduction
0 commit comments