Skip to content

Commit 3d2b748

Browse files
committed
docs: update contrib guide for windows users and note that lib needs to run before storybook
1 parent 8d90e6f commit 3d2b748

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ Thanks for contributing!
44

55
## Getting Started
66

7-
This is a pnpm monorepo, consisting of the main package in [`lib`](../lib/) and [`storybook`](./storybook/) and [`example`](./example/) packages in the `docs` directory. Don't worry if you haven't used pnpm or monorepos before, the
8-
commands below will set everything up for you.
7+
This is a pnpm monorepo, consisting of the main package in [`lib`](../lib/) and
8+
[`storybook`](./storybook/) and [`example`](./example/) packages in the `docs` directory. Don't
9+
worry if you haven't used pnpm or monorepos before, the commands below will set everything up for you.
10+
11+
If you run Windows please use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
912

1013
Ensure you're using the Node version specified in [.nvmrc](../.nvmrc) and run the following to
1114
bootstrap the project:
@@ -19,7 +22,7 @@ pnpm install-completion
1922
To start the library in watch mode, run the following command:
2023

2124
```sh
22-
# Run the library only.
25+
# Run the library only, note this must run before starting Storybook.
2326
pnpm run --filter react-compare-slider dev
2427
# You can also run the scripts from the directory itself if you prefer.
2528
cd lib

0 commit comments

Comments
 (0)