Updates to stable criteria #9
Conversation
Done: - Added Figma component to alpha and stable Todo: - Review accessibility criteria - Review design review criteria - Review design guidelines criteria
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/monalisa/primer-contribute/9XtbmStTD8mVHmUDXqfgTTgdkPdS |
| @@ -20,6 +20,7 @@ The component is ready for preliminary usage, with breaking changes expected. | |||
| - Basic documentation exists that includes example usage of the component. | |||
There was a problem hiding this comment.
It's been hard for me to know whether my components meet this criteria because "basic documentation" is so vague.
What criteria do we have for "basic"?
What do we mean by "documentation"? Do we mean design guidelines? Engineering docs?
cc @colebemis - we talked about this a few weeks ago, and you might have some thoughts on this criteria.
| @@ -20,6 +20,7 @@ The component is ready for preliminary usage, with breaking changes expected. | |||
| - Basic documentation exists that includes example usage of the component. | |||
| - Primary use cases tested and reviewed. | |||
| - The component has 100% test coverage. | |||
| - The default component is available in the Primer Web library in Figma. | |||
There was a problem hiding this comment.
I don't understand what we mean by "default component". I'd recommend we don't make Figma implementation an Alpha requirement. I think it can wait until Beta.
|
|
||
| ## Stable | ||
|
|
||
| The component is significantly mature and usage is strongly encouraged, with long-term support expected. | ||
|
|
||
| - The API remains stable, with no breaking changes for at least one month. Feedback on API usability has been sought from developers using the component and production use cases have been reviewed for correctness. | ||
| - Documentation exists for the remaining implementation, usage, and design guidelines. Primer React and/or Primer ViewComponents documentation includes all props and variations, accessibility guidelines (including common misuses), and common scenarios. Design documentation is added to Interface Guidelines. Figma components are available in the Primer Web library. | ||
| - Documentation exists for the remaining implementation, usage, and design guidelines. Primer React and/or Primer ViewComponents documentation includes all props and variations, accessibility guidelines (including common misuses), and common scenarios. Design documentation is added to Interface Guidelines. |
There was a problem hiding this comment.
Primer React and/or Primer ViewComponents documentation includes all props and variations
"Stable" seems a little late for this. If product teams using these components when they're in "Alpha" or "Beta", they should at least have props and variations documented.
Done:
Todo: