Skip to content

Copilot: Improve instructions, setup steps #33231

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

Merged
JReinhold merged 10 commits into from
Dec 22, 2025
+200 −356
Merged

Copilot: Improve instructions, setup steps #33231

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fb764ab
remove kiro files
JReinhold Nov 28, 2025
0e3cdf6
modify copilot instructions to match new nx+sandbox setup
JReinhold Nov 28, 2025
2bea5ff
add copilot setup steps
JReinhold Nov 28, 2025
c6b3e0b
default permissions
JReinhold Nov 28, 2025
5e3e8c3
Merge branch 'next' into jeppe/improve-copilot
JReinhold Nov 28, 2025
a75504b
try with low permissions again
JReinhold Nov 28, 2025
beda955
Merge branch 'next' into jeppe/improve-copilot
JReinhold Dec 8, 2025
73acb20
Merge branch 'next' of github.com:storybookjs/storybook into jeppe/im…
JReinhold Dec 22, 2025
1d3f03d
fix yarn task instructions
JReinhold Dec 22, 2025
223f249
Merge branch 'jeppe/improve-copilot' of github.com:storybookjs/storyb…
JReinhold Dec 22, 2025
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
Prev Previous commit
Next Next commit
fix yarn task instructions
  • Loading branch information
@JReinhold
JReinhold committed Dec 22, 2025
commit 1d3f03dd4956d17ebbadb560d3dd6ea72f16c2e7
30 changes: 15 additions & 15 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ yarn # Install all dependencies (~2.5 min)
**Using yarn task (custom task runner):**

```bash
yarn task --task compile # Compile all packages (~3 min)
yarn task compile # Compile all packages (~3 min)
```

**Using NX (recommended for better caching):**
Expand All @@ -68,7 +68,7 @@ yarn lint # Run all linting checks (~4 min)
### Type Checking

```bash
yarn task --task check # TypeScript type checking
yarn task check # TypeScript type checking
# OR with NX:
yarn nx run-many -t check -c production
```
Expand All @@ -92,10 +92,10 @@ cd code && yarn test:watch # Watch mode
cd code && yarn storybook:vitest # Storybook UI specific tests

# Task-based testing (with template sandboxes)
yarn task --task e2e-tests-dev --template react-vite/default-ts
yarn task --task e2e-tests-build --template react-vite/default-ts
yarn task --task test-runner-dev --template react-vite/default-ts
yarn task --task test-runner-build --template react-vite/default-ts
yarn task e2e-tests-dev --template react-vite/default-ts --start-from auto
yarn task e2e-tests-build --template react-vite/default-ts --start-from auto
yarn task test-runner-dev --template react-vite/default-ts --start-from auto
yarn task test-runner-build --template react-vite/default-ts --start-from auto
```

## NX Task Runner (Recommended)
Expand All @@ -106,15 +106,15 @@ The repository uses NX for task orchestration with better caching and dependency

```bash
# Compilation
yarn task --task compile --no-link
yarn task compile --no-link
yarn nx run-many -t compile -c production

# E2E tests on specific template
yarn task --task e2e-tests-dev --template react-vite/default-ts --no-link
yarn task e2e-tests-dev --template react-vite/default-ts --start-from auto --no-link
yarn nx e2e-tests-dev react-vite/default-ts -c production

# Skip task dependencies (start from a specific step)
yarn task --task e2e-tests-dev -s e2e-tests --template react-vite/default-ts --no-link
yarn task e2e-tests-dev --start-from e2e-tests --template react-vite/default-ts --no-link
yarn nx e2e-tests-dev -c production --exclude-task-dependencies
```

Expand All @@ -129,7 +129,7 @@ yarn nx e2e-tests-dev -c production --exclude-task-dependencies

### Commands to Avoid

- **DO NOT RUN**: `yarn task --task dev` - This starts a permanent development server that runs indefinitely
- **DO NOT RUN**: `yarn task dev` - This starts a permanent development server that runs indefinitely
- **DO NOT RUN**: `yarn start` - Also starts a long-running development server

### Sandbox Location Change
Expand Down Expand Up @@ -169,7 +169,7 @@ The repository includes task scripts in `scripts/tasks/`:

### For Testing UI Changes

1. Generate a sandbox: `yarn task --task sandbox --template react-vite/default-ts`
1. Generate a sandbox: `yarn task sandbox --template react-vite/default-ts --start-from auto`
- Sandboxes are created at `../storybook-sandboxes/` by default
2. If sandbox generation fails, use Storybook UI: `cd code && yarn storybook:ui`
3. Access at http://localhost:6006/
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 22, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Wrap bare URLs in markdown link syntax or code formatting.

Lines 175 and 263 contain bare URLs (http://localhost:6006/) that trigger markdown linting warnings. For consistency with markdown best practices, either wrap them in markdown link syntax ([link](url)) or ensure they're in code blocks.

🔎 Suggested fixes

For line 175 (in context):

- Access at http://localhost:6006/
+ Access at [http://localhost:6006/](http://localhost:6006/)

For line 263 (in context):

- Access at http://localhost:6006/ to test your changes
+ Access at [http://localhost:6006/](http://localhost:6006/) to test your changes

Also applies to: 263-263

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

175-175: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
.github/copilot-instructions.md lines 175 and 263: both lines contain a bare URL
"http://localhost:6006/" which triggers markdown-lint warnings; update each
occurrence to either markdown link syntax (e.g.,
[http://localhost:6006/](http://localhost:6006/)) or surround it with inline
code/backticks (`http://localhost:6006/`) so the URL is not a bare link and the
lint warning is resolved.

Expand Down Expand Up @@ -213,7 +213,7 @@ Sandboxes are test environments that allow you to test Storybook changes with di

```bash
# Generate a new sandbox (run from repository root)
yarn task --task sandbox --template react-vite/default-ts
yarn task sandbox --template react-vite/default-ts --start-from auto
# Creates: ../storybook-sandboxes/react-vite-default-ts/

# Using NX (with -c production flag required)
Expand Down Expand Up @@ -298,9 +298,9 @@ cd code && yarn test
### End-to-End Testing

- Playwright tests available (version 1.52.0 configured)
- E2E test tasks: `yarn task --task e2e-tests-build` or `yarn task --task e2e-tests-dev`
- Test runner scenarios: `yarn task --task test-runner-build` or `yarn task --task test-runner-dev`
- Smoke tests: `yarn task --task smoke-test`
- E2E test tasks: `yarn task e2e-tests-build --start-from auto` or `yarn task e2e-tests-dev --start-from auto`
- Test runner scenarios: `yarn task test-runner-build --start-from auto` or `yarn task test-runner-dev --start-from auto`
- Smoke tests: `yarn task smoke-test --start-from auto`

### Watch Mode Commands

Expand Down