Skip to content

Docs: update watch mode cli command examples in CONTRIBUTING.md #33236

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

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Docs: update watch mode cli command examples in CONTRIBUTING.md #33236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ If you want to make code changes to Storybook packages while running a sandbox,

1. In a second terminal, run `yarn build --watch <package-1> <package-2>` in the `code/` directory.

For example, if you want to build the `@storybook/react`, `@storybook/core-server`, `@storybook/api`, and `@storybook/addon-docs` packages, you would run:
For example, if you want to build the `@storybook/react`, `storybook` itself, `@storybook/builder-vite`, and `@storybook/addon-docs` packages, you would run:

```shell
# Navigate to the code directory
Expand All @@ -171,10 +171,10 @@ yarn build --watch react core-server api addon-docs

Most package names can be found after `@storybook/` in the published package.

For instance, to build the `@storybook/react @storybook/core-server @storybook/api @storybook/addon-docs` packages at the same time in watch mode:
For instance, to build the `@storybook/react storybook @storybook/builder-vite @storybook/addon-docs` packages at the same time in watch mode:

```shell
cd code yarn build --watch react core-server api addon-docs
cd code yarn build --watch react storybook builder-vite addon-docs
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Shell command formatting is broken; missing newline between separate commands.

The command combines cd code and yarn build on a single line, which will fail to execute properly. Each command should be on its own line.

Apply this diff to fix the formatting:

- cd code yarn build --watch react storybook builder-vite addon-docs 
+ cd code
+ yarn build --watch react storybook builder-vite addon-docs
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cd code yarn build --watch react storybook builder-vite addon-docs
cd code
yarn build --watch react storybook builder-vite addon-docs
🤖 Prompt for AI Agents 
In CONTRIBUTING.md around line 177 the shell example combines multiple commands
on one line ("cd code yarn build --watch react storybook builder-vite
addon-docs"); split these into separate commands each on its own line so that
"cd code" is on its own line followed by the individual yarn commands (or a
single yarn command with proper flags) on subsequent lines, ensuring each
command is newline-separated and executable in a shell.

```

2. If you are running the sandbox in ["linked"](https://yarnpkg.com/cli/link) mode (the default), you should see the changes reflected on a refresh (you may need to restart it if changing server packages)
Expand All @@ -198,7 +198,7 @@ yarn task --prod

```shell
# Builds the specified packages in production mode
yarn build --prod --watch angular core addon-docs
yarn build --prod --watch angular storybook addon-docs
```

### Running against different sandbox templates
Expand Down
Loading