Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Minor changes for code contribution docs #24916

Merged
merged 4 commits into from
Nov 20, 2023
Merged

Docs: Minor changes for code contribution docs #24916

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e3c955
Docs: Minor changes for code contribution docs
jonniebigodes Nov 20, 2023
d859e39
Capitalize Node
jonniebigodes Nov 20, 2023
2f4cbb7
Merge branch 'next' into docs_updates_contributions
jonniebigodes Nov 20, 2023
6a94ba8
Merge branch 'next' into docs_updates_contributions
jonniebigodes Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/contribute/code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Contribute a new feature or bug fix to [Storybook's monorepo](https://github.com

## Prerequisites

- Ensure you have node version 16 installed (suggestion: v16.17.1).
- Ensure you have Node version 18 installed (suggestion: v18.16.0).
- Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL).

## Initial setup
Expand All @@ -18,7 +18,7 @@ git clone https://github.com/your-username/storybook.git
cd storybook
```

Storybook uses the [yarn](https://v3.yarnpkg.com/) package manager. Use [Corepack](https://github.com/nodejs/corepack) to set up the correct version for use with Storybook.
Storybook uses the [Yarn](https://yarnpkg.com/) package manager. Use [Corepack](https://github.com/nodejs/corepack) to set up the correct version for use with Storybook.

```shell
corepack enable
Expand Down Expand Up @@ -201,7 +201,7 @@ npx storybook@next link --local /path/to/local-repro-directory

<Callout variant="info" icon="💡">

The `storybook link` command relies on [Yarn 2 linking](https://yarnpkg.com/cli/link/) under the hood. It requires your local reproduction to be using [Yarn 2](https://yarnpkg.com/) as well, which is the case if you're already enabled it with the [`storybook sandbox`](./how-to-reproduce.md) command per our contribution guidelines. The process will fail if you're trying to link a non-Yarn 2 project.
The `storybook link` command relies on [Yarn linking](https://yarnpkg.com/cli/link/) under the hood. It requires your local reproduction to be using [Yarn 2 or higher](https://yarnpkg.com/) as well, which is the case if you've already enabled it with the [`storybook sandbox`](./how-to-reproduce.md) command per our contribution guidelines. The process will fail if you're trying to link a non-Yarn 2 project.

</Callout>

Expand Down