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

Commit 50cab7d

Browse files
Merge pull request #169 from TylerAPfledderer/docs/update-contributing
docs(contributing): update details
2 parents 3224e15 + 3abc7f5 commit 50cab7d

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,29 @@ git clone https://github.com/<your_github_username>/chakra-ui-vue-next.git
1818
cd chakra-ui
1919
```
2020

21-
3. Build components
22-
```bash
23-
yarn build
24-
```
25-
26-
4. Setup all the dependencies and packages by running `yarn bootstrap`. This
27-
command will install dependencies and bootstrap the repo using `lerna`
28-
```bash
29-
yarn bootstrap
21+
3. Install dependencies and bootstrap the project
22+
```sh
23+
yarn
24+
# After the dependencies are installed, the `postinstall` script with trigger `preconstruct dev` which will build all the component packages.
3025
```
3126

32-
> If you run into any issues during this step, kindly reach out to the Chakra UI
27+
> If you run into any issues during these steps, kindly reach out to the Chakra UI
3328
> Vue team here:[https://discord.gg/cMpMfvxa](https://discord.gg/cMpMfvxa)
3429
30+
## For Windows OS Users
31+
There may be some trouble specific to the local setup in Windows. The following are suggestions in ensuring the local environment boots up successfully:
32+
33+
- 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)
35+
3536
## Development
3637

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

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+
4144
### Tooling
4245

4346
- [Lerna](https://lerna.js.org/) to manage installation of dependencies and
@@ -57,7 +60,7 @@ cross-component development and builds all components.
5760
**`yarn bootstrap`**: bootstraps the entire project and symlinks all
5861
dependencies for cross-component development.
5962

60-
**`yarn dev`**: starts components playground server and loads stories in SFCs in the `packages/**/examples/*.vue` file.
63+
**`yarn playground:dev`**: starts components playground server and loads stories in SFCs in the `packages/**/examples/*.vue` file.
6164

6265
**`yarn docs:dev`**: run the documentation site locally.
6366

@@ -110,7 +113,9 @@ docs, simply run `yarn build`, and `yarn docs:dev`
110113

111114
### Components Development Playground
112115

113-
Build components in isolation with Storybook using `yarn dev`
116+
Build components in isolation with Vite using `yarn playground:dev`
117+
118+
Run `yarn start` in a separate terminal first so the packages are built and a watcher set up for changes.
114119

115120
## Think you found a bug?
116121

0 commit comments

Comments
 (0)