Contributor checklist (docs, tests, accessibility)
Use this checklist before opening a PR. Skip items that clearly do not apply (for example, copy-only fixes).
Documentation
- Docs site: If behavior or public API changed, updated the relevant docs page(s) under the docs app.
- Storybook: Added or updated stories when visuals, states, or interactions changed.
- README / exports: If you changed
package.jsonexports or installation steps, updated root docs accordingly.
Tests
- Snapshots: Followed the snapshot testing policy — prefer semantic assertions over full-tree snapshots.
- Unit / component tests: Added or updated tests for new behavior and regressions.
- Edge cases: Covered empty states, controlled vs uncontrolled usage (if applicable), and keyboard interaction where relevant.
- Browser-sensitive changes: Checked the browser support matrix and ran the relevant manual QA when behavior depends on layout, focus, portals, or scrolling.
- Flaky failures: If any test was quarantined, followed the flaky test quarantine policy with an owner and follow-up issue.
Accessibility
- Roles and labels: Interactive elements have appropriate roles, labels, and (where needed) descriptions.
- Keyboard: Focus order and focus visibility are reasonable; Escape / arrow keys behave as expected for the pattern.
- Motion: Respects
prefers-reduced-motionwhen adding animation (if applicable).
Public API changes
- New exports: Followed the API review checklist when adding or changing supported public symbols.
Release hygiene
- Changeset: Added a
.changesetentry when the change should appear in the changelog (see Changeset quality). - Breaking changes: Documented breaking behavior explicitly in the changeset when bumping major.
Reviewer-friendly PR
- Linked the tracking issue (if any) and summarized what and why.
- Called out screenshots or Storybook links for visual changes.