Skip to content

chore: 🤖 add component RFC pull request template#871

Merged
elizabetdev merged 1 commit intomainfrom
chore/component-rfc-pr-template
Mar 4, 2026
Merged

chore: 🤖 add component RFC pull request template#871
elizabetdev merged 1 commit intomainfrom
chore/component-rfc-pr-template

Conversation

@elizabetdev
Copy link
Member

Why?

We need a structured, RFC-style PR template for new components and significant component changes. This ensures every component PR goes through a consistent review process covering design, API, accessibility, theming, testing, documentation, and migration concerns.

How?

  • Moved the existing default PR template into .github/PULL_REQUEST_TEMPLATE/default.md (no content changes)
  • Added a new Component RFC template at .github/PULL_REQUEST_TEMPLATE/component_rfc.md
  • The RFC template includes comprehensive checklists for:
    • Design reference & Figma link
    • Proposed API with usage examples
    • Variants & states coverage
    • Accessibility requirements (ARIA, keyboard nav, screen reader, contrast)
    • Light/dark theming with design tokens
    • Implementation standards (file structure, exports, types)
    • Testing (unit, visual regression, Storybook stories)
    • Documentation
    • Changeset
    • Security
    • Rollout & migration (for changes to existing components)

Usage

When opening a PR, contributors can append ?template=component_rfc.md to the PR URL to use the RFC template, or select it from the template picker.

Contribution checklist?

  • You've done enough research before writing
  • You have reviewed the PR
  • The commit messages are detailed
  • Assets or static content are linked and stored in the project

Security checklist?

  • All user inputs are validated and sanitized
  • No usage of dangerouslySetInnerHTML
  • Sensitive data has been identified and is being protected properly
  • Build output contains no secrets or API keys

Made with Cursor

Introduces a dedicated PR template for new components and component
changes that works as an RFC with a full checklist covering design,
API, accessibility, theming, testing, documentation, and migration.

The existing default template is preserved and moved into the
PULL_REQUEST_TEMPLATE directory so contributors can choose the
appropriate template when opening a PR.

Made-with: Cursor
@changeset-bot
Copy link

changeset-bot bot commented Mar 4, 2026

⚠️ No Changeset found

Latest commit: 53f47da

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

@elizabetdev elizabetdev merged commit d7a19eb into main Mar 4, 2026
8 of 9 checks passed
@elizabetdev elizabetdev deleted the chore/component-rfc-pr-template branch March 4, 2026 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants