Skip to content

feat(.ai): add consumer migration skill#6145

Merged
caseyisonit merged 34 commits into
mainfrom
marissahuysentruyt/feat-consumer-migration-skill
Apr 21, 2026
Merged

feat(.ai): add consumer migration skill#6145
caseyisonit merged 34 commits into
mainfrom
marissahuysentruyt/feat-consumer-migration-skill

Conversation

@marissahuysentruyt
Copy link
Copy Markdown
Collaborator

@marissahuysentruyt marissahuysentruyt commented Apr 6, 2026

Description

⚠️ SECOND PARALLEL MERGE ⚠️
Can be merged directly into feat-agnostic-ai-folder-stuff before or after the washing machine skills PR #6127 or #6139

Adds a consumer-facing migration guide for the Badge component, covering what changed between 1st-gen and 2nd-gen, how to update markup/attributes/slots, styling and customization changes, accessibility expectations, and rollout/testing guidance.

Also ships a reusable .ai skill (consumer-migration-guide) so the same guide structure can be generated consistently for any other component going forward.

Changes:

  • CONTRIBUTOR-DOCS/03_project-planning/03_components/badge/consumer-migration-guide.md: full consumer migration guide for Badge
  • .ai/skills/consumer-migration-guide/SKILL.md: skill definition for generating per-component consumer migration guides
  • .ai/skills/consumer-migration-guide/references/consumer-migration-guide-prompt.md: prompt
  • .ai/README.md: updated to document the new skill
  • CONTRIBUTOR-DOCS/03_project-planning/03_components/README.md: updated index
  • 2nd-gen/packages/swc/.storybook/preview.ts: minor update

Motivation and context

Application developers migrating from 1st-gen to 2nd-gen (for example, sp-badge to swc-badge) need practical, consumer-focused guidance that goes beyond internal implementation analysis. This doc covers the day-to-day upgrade path: what to search for, what to change, and how to validate the result. The skill ensures creating a migration guide for consumers is repeatable for every subsequent component migration.

Related issue(s)

  • partially addresses 1675
  • swc-1894

Screenshots (if appropriate)


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

  • Badge consumer migration guide is accurate and complete
  1. Open CONTRIBUTOR-DOCS/03_project-planning/03_components/badge/consumer-migration-guide.md
  2. Follow the "Update your code" section using a real sp-badge usage as input (maybe just try to plop it on the badge storybook docs page as a new story?)
  3. Expect the before/after examples to produce a working swc-badge with no regressions
  • Consumer migration skill generates a correct guide for a new component
  1. Invoke the consumer-migration-guide skill for a second component (e.g. status light)
  2. Expect the output to follow the same structure as the Badge guide
  3. Confirm links to rendering-and-styling-migration-analysis.md and accessibility-migration-analysis.md are
    present where those docs exist

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

Accessibility testing checklist

Required: Complete each applicable item and document your testing steps (replace the placeholders with your component-specific instructions).

  • Keyboard
    documentation only

  • Screen reader
    documentation only

@marissahuysentruyt marissahuysentruyt self-assigned this Apr 6, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 6, 2026

⚠️ No Changeset found

Latest commit: 46dc5ce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@marissahuysentruyt marissahuysentruyt added Status:WIP PR is a work in progress or draft 1.0.0 Issues that should be addressed for a 1.0 release! Component:Tooling Issue or PR dealing with scripts, workflows, automation, etc. Component prefix is for Jira do-not-merge NO MERGE-Y! 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. labels Apr 6, 2026
@marissahuysentruyt marissahuysentruyt changed the base branch from main to marissahuysentruyt/feat-agnostic-folder-ai-stuff April 6, 2026 21:13
@marissahuysentruyt marissahuysentruyt changed the title Marissahuysentruyt/feat consumer migration skill feat(.ai): add consumer migration skill Apr 6, 2026
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/feat-consumer-migration-skill branch from 3be2546 to 3dd84b6 Compare April 6, 2026 21:18
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 6, 2026

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6145

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

…skill

- The a11y migration analysis doc is a full authoring playbook, not a
linting rule. Moves it from .ai/rules/ to .ai/skills/ with a SKILL.md
that mirrors the component-migration-analysis skill structure.

- Also fixes a stale .cursor/ path reference in
component-migration-analysis/SKILL.md.
- Delete .cursor/README.md and .cursor/config.json
- Delete all skill files under .cursor/skills/
Base automatically changed from marissahuysentruyt/feat-agnostic-folder-ai-stuff to main April 13, 2026 19:25
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this just resolved linter issues with links

@caseyisonit caseyisonit marked this pull request as ready for review April 21, 2026 18:19
@caseyisonit caseyisonit requested a review from a team as a code owner April 21, 2026 18:19
@caseyisonit caseyisonit added Status:Ready for review PR ready for review or re-review. High priority PR review PR is a high priority and should be reviewed ASAP AI tooling and removed Status:WIP PR is a work in progress or draft do-not-merge NO MERGE-Y! labels Apr 21, 2026
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

allows the migration guides to get picked up

Comment thread .vscode/settings.json
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

to quiet spell check

Copy link
Copy Markdown
Member

@cdransf cdransf left a comment

Choose a reason for hiding this comment

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

Looks good! Just one note ✨

Comment thread 2nd-gen/packages/swc/components/badge/consumer-migration-guide.mdx Outdated
caseyisonit and others added 3 commits April 21, 2026 16:56
@caseyisonit caseyisonit enabled auto-merge (squash) April 21, 2026 23:05
@caseyisonit caseyisonit merged commit 022d6ee into main Apr 21, 2026
29 checks passed
@caseyisonit caseyisonit deleted the marissahuysentruyt/feat-consumer-migration-skill branch April 21, 2026 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.0.0 Issues that should be addressed for a 1.0 release! 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. AI tooling Component:Tooling Issue or PR dealing with scripts, workflows, automation, etc. Component prefix is for Jira High priority PR review PR is a high priority and should be reviewed ASAP Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants