Docs: update watch mode cli command examples in CONTRIBUTING.md #33236
Conversation
jonniebigodes
added
documentation
ci:docs
📝 WalkthroughWalkthroughUpdated documentation examples in CONTRIBUTING.md to reflect package name changes, replacing references to core-server/api with storybook/builder-vite and adjusting package listings for build command examples across different build modes and configurations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
163-170: Package names in command don't match the description above.Line 163 describes building
@storybook/react,storybook,@storybook/builder-vite, and@storybook/addon-docs, but Line 170's command uses the old package names (core-server api) instead of the new ones (storybook builder-vite). The command and description are now inconsistent after your update.Apply this diff to fix the command:
# Build the specified packages in watch mode - yarn build --watch react core-server api addon-docs + yarn build --watch react storybook builder-vite addon-docs
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
163-163: Minor: Consider varying the phrasing to reduce repetition.The phrase "if you want to build" appears in close proximity to earlier sentences on line 161–162 ("If you want to make code changes"). Using different phrasing can improve readability.
Consider revising line 163 to something like: "To build the
@storybook/react,storybook,@storybook/builder-vite, and@storybook/addon-docspackages, you would run:"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(3 hunks)
🧰 Additional context used
🧠 Learnings (9)
📓 Common learnings
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Applies to README.md : Update relevant README files for significant code changes
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Applies to code/{addons,frameworks}/**/README.md : Include code examples in addon/framework documentation for significant changes
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Follow existing patterns and conventions in the Storybook codebase
📚 Learning: 2025-11-28T14:50:24.872Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Applies to README.md : Update relevant README files for significant code changes
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-11-28T14:50:24.872Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Applies to code/{addons,frameworks}/**/README.md : Include code examples in addon/framework documentation for significant changes
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-10-01T15:24:01.060Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32594
File: code/core/src/components/components/Popover/WithPopover.tsx:7-9
Timestamp: 2025-10-01T15:24:01.060Z
Learning: In the Storybook repository, "react-aria-components/patched-dist/*" (e.g., "react-aria-components/patched-dist/Dialog", "react-aria-components/patched-dist/Popover", "react-aria-components/patched-dist/Tooltip") are valid import paths created by a patch applied to the react-aria-components package. These imports should not be flagged as broken or invalid until a maintainer explicitly states they are no longer acceptable.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-10-02T09:22:13.215Z
Learnt from: JReinhold
Repo: storybookjs/storybook PR: 32607
File: code/package.json:243-243
Timestamp: 2025-10-02T09:22:13.215Z
Learning: The Storybook repository uses Yarn v^4 (any 4.x version) as the package manager, configured via .yarnrc.yml and package.json packageManager field. Specific patch versions within v4 can be upgraded as needed.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-09-17T07:31:04.432Z
Learnt from: ndelangen
Repo: storybookjs/storybook PR: 32484
File: code/core/package.json:326-326
Timestamp: 2025-09-17T07:31:04.432Z
Learning: In Storybook's core package, dependencies like `open` are bundled into the final distribution during the build process, so they should remain in devDependencies rather than being moved to dependencies. End users don't need these packages as separate runtime dependencies since they're included in the bundled code.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-09-29T13:20:23.346Z
Learnt from: mrginglymus
Repo: storybookjs/storybook PR: 32556
File: code/core/package.json:309-313
Timestamp: 2025-09-29T13:20:23.346Z
Learning: The `fast-printf` dependency in Storybook's core package is bundled into the final distribution during the build process, so it should remain in devDependencies rather than being moved to dependencies, following the same pattern as other bundled dependencies like `open`.
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-11-28T14:50:24.872Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Follow existing patterns and conventions in the Storybook codebase
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-11-28T14:50:24.872Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-28T14:50:24.872Z
Learning: Use Yarn 4.9.1 as the package manager
Applied to files:
CONTRIBUTING.md
🪛 LanguageTool
CONTRIBUTING.md
[style] ~163-~163: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...code/ directory. For example, if you want to build the @storybook/react, `storyboo...
(REP_WANT_TO_VB)
|
|
||
| ```shell | ||
| cd code yarn build --watch react core-server api addon-docs | ||
| cd code yarn build --watch react storybook builder-vite addon-docs |
There was a problem hiding this comment.
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.
| 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 participants
What I did
hello there 👋
This PR updates the CONTRIBUTING.md file. Some packages in commands seems to be old storybook <= 8 packages that has been moved into core since.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.