pr

Source excerpt starting at line 1.

1---2name: pr3description: Creates a pull request following Storybook conventions. Use when creating PRs, opening pull requests, or submitting changes for review.4allowed-tools: Bash, Read5---6 7# Create Pull Request8 9Creates a PR following Storybook conventions.10 11## Title format12 13`[Area]: [Description]`14 15- Area is capitalized, no spaces (dashes allowed)16- Examples:17  - `CSFFactories: Fix type export`18  - `Nextjs-Vite: Add support`19  - `CLI: Fix automigrate issue`20 21## Labels22 23Add these labels to the PR:24 25**Category (required, pick one):**26 27- `bug` - fixes incorrect behavior28- `maintenance` - user-facing maintenance29- `dependencies` - upgrading/downgrading deps30- `build` - internal build/test updates (no changelog)31- `cleanup` - minor cleanup (no changelog)32- `documentation` - docs only (no changelog)33- `feature request` - new feature34- `BREAKING CHANGE` - breaks compatibility35- `other` - doesn't fit above36 37**CI (required, pick one):**38 39- `ci:normal` - standard sandbox set; default for most code changes40- `ci:merged` - merged sandbox set41- `ci:daily` - daily sandbox set; use this when changes affect prerelease sandboxes or sandboxes pinned to a framework or React version other than latest42- `ci:docs` - documentation-only changes (use with `documentation` category)43 44**Canary (optional):**45 46- `ci:canary` - publish pkg.pr.new canary packages for an in-repo PR; later pushes republish while the label remains. Does nothing on fork PRs. To canary a fork PR, a maintainer runs `publish-canary.yml` with the `pr` input; do not ask the fork author to publish. Do not add this label unless the user asks for a canary.47 48**QA (required, pick one):**49 50Tells the release team whether manual QA is needed before the next minor release.51 52- `qa:needed` — a human must manually verify this PR at release time53- `qa:skip` — no per-PR manual QA needed at release time54 55Heuristics:56 57- User explicitly asked for manual QA before release → `qa:needed`58- Part of a larger project that gets holistic QA (not per-PR) → `qa:skip`59- Touches paths, filesystem, or anything that could break on Windows → `qa:needed`60- Complex change spanning multiple areas that must work together → `qa:needed`61- Small change in central/shared code with high side-effect risk (e.g. layout CSS in shared UI) → `qa:needed`62- Simple, straightforward change → `qa:skip`63- Unsure → ask the user whether manual QA before minor release is necessary64 65## PR body66 67Read `.github/PULL_REQUEST_TEMPLATE.md` from the repository root.68 69Copy that template **EXACTLY**, including all HTML comments (`<!-- ... -->`). Fill in the relevant sections based on the changes, but keep all comments intact.70 71### Manual testing (required)72 73The **Manual testing** section is mandatory — never leave it empty. Write steps for a separate maintainer, not a log of how you tested.74 75Each step should be:76 77- Clear and easy to follow78- Copy-pasteable shell commands where applicable79- Explicit about what behavior to inspect (expected outcome, not just "check it works")80- Linked to specific stories for UI changes, or to build artifacts when relevant81- Lists areas most likely to regress and worth extra scrutiny82 83**Verify your own steps first** — run through them locally before opening the PR.84 85When useful, link to published Chromatic Storybooks (CI must finish first; links won't work immediately after opening the PR):86 87- Internal UI: `https://<branch>--635781f3500dd2c49e189caf.chromatic.com/?path=/story/<story_id>`88- React Vite TS: `https://<branch>--630511d655df72125520f051.chromatic.com/?path=/story/<story_id>`89 90Replace `<branch>` with Chromatic's normalized slug (special chars → dashes, e.g. `feature/foo` → `feature-foo`) and `<story_id>` with the story path (e.g. `example-button--primary`).91 92## Command93 94Always create PRs in draft mode:95 96```bash97gh pr create --draft --title "<Area>: <Description>" --body "<FILLED_TEMPLATE>" --label "<category>,<ci>,<qa>"98```99