Skip to content
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.

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

[AI] Mark AISkeleton components stable #16762

Closed
24 tasks
Tracked by #16619
tay1orjones opened this issue Jun 12, 2024 · 0 comments · Fixed by #16803
Closed
24 tasks
Tracked by #16619

[AI] Mark AISkeleton components stable #16762

tay1orjones opened this issue Jun 12, 2024 · 0 comments · Fixed by #16803

Comments

@tay1orjones
Copy link
Member

tay1orjones commented Jun 12, 2024

Follow the established "move to stable" checklist:

  • All files have a copyright banner
  • All components exported in src/index.js and should not be unstable_
    prefixed
  • Component has a label in the GitHub repository
  • Component should be documented on the website
    • Component should have a usage, style, and code tab
    • Component may have a component demo
  • For each component exported:
    • Component is written as a function declaration or uses forwardRef
    • Component has propTypes defined
      • Each prop type has a comment (used in storybook)
      • Prop types are as specific as needed, prefer PropTypes.shape over
        PropTypes.object if possible
    • Default props are listed as default args in the function definition (not
      in defaultProps)
      • Note: default props should be stable, in other words props like
        onClick = () => {} can cause re-renders since the function identity
        is not stable
    • Component has a story in <ComponentName>.stories.js
      • Component has an mdx document that follows our outline
      • mdx document coverages at least common use-cases and provides a prop
        table
      • Stories cover at least common use-cases
      • Stories may include a Playground story for controls
        • Controls with no meaningful change to the component visuals should
          be hidden from the controls panel, eg. className
        • Props of type node with no proper controls available for
          configuration should be hidden from the controls panel, eg.
          children
      • Stories should mirror intended usage of the component
    • Component has unit/integration tests written in RTL for testing the
      component API
    • Component is tested via VRT for at least the initial render state
    • Component is tested via AVT for at least the initial render state
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant