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

Commit 438d1a5

Browse files
committed
docs: update contributing guide
1 parent db54c19 commit 438d1a5

File tree

4 files changed

+40
-257
lines changed

4 files changed

+40
-257
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,17 @@ cd chakra-ui
2020

2121
3. Install dependencies and bootstrap the project
2222
```sh
23-
yarn
24-
# After the dependencies are installed, the `postinstall` script with trigger `preconstruct dev` which will build all the component packages.
23+
pnpm install
24+
```
25+
26+
4. Start development server for packages
27+
```sh
28+
pnpm dev
29+
```
30+
31+
5. Open component playground
32+
```sh
33+
pnpm playground:dev
2534
```
2635

2736
> If you run into any issues during these steps, kindly reach out to the Chakra UI
@@ -31,7 +40,7 @@ yarn
3140
There may be some trouble specific to the local setup in Windows. The following are suggestions in ensuring the local environment boots up successfully:
3241

3342
- The package dependencies and scripts should work with Node `v16.16.0 and higher`
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)
43+
3544

3645
## Development
3746

package.json

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
1313
]
1414
},
1515
"scripts": {
16-
"postinstall": "preconstruct dev",
17-
"dev": "preconstruct dev",
16+
"dev": "turbo run dev",
1817
"clean": "pnpm -r --parallel run clean",
1918
"prebuild": "pnpm clean",
2019
"build": "turbo run build --filter=!./examples/* --filter=!{./packages/test-utils}",
@@ -25,7 +24,6 @@
2524
"postbuild": "pnpm pkgs:size",
2625
"build:fast": "turbo run build:fast --filter=!./examples/* --filter=!{./packages/test-utils}",
2726
"postbuild:fast": "pnpm pkgs:size",
28-
"start": "preconstruct watch",
2927
"scaffold": "hygen generator",
3028
"preplaygound:dev": "node ./scripts/dev.js",
3129
"playground:dev": "cross-env NODE_ENV=development vite serve playground --config ./vite.config.ts --open",
@@ -104,7 +102,6 @@
104102
"@nuxt/schema": "^3.0.0",
105103
"@nuxt/test-utils": "^3.0.0",
106104
"@popperjs/core": "^2.8.4",
107-
"@preconstruct/cli": "^2.1.5",
108105
"@rollup/plugin-multi-entry": "^6.0.0",
109106
"@rollup/plugin-typescript": "^11.0.0",
110107
"@size-limit/file": "^5.0.3",
@@ -229,12 +226,6 @@
229226
"vue3-perfect-scrollbar": "^1.5.5",
230227
"yargs": "^17.6.2"
231228
},
232-
"preconstruct": {
233-
"packages": [
234-
"packages/*",
235-
"tooling/*"
236-
]
237-
},
238229
"resolutions": {
239230
"csstype": "3.1.1",
240231
"@chakra-ui/theme-tools": "2.0.17"

0 commit comments

Comments
 (0)