Skip to content

Updates to stable criteria #9

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −1
Draft

Updates to stable criteria #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/component-lifecycle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Choose a reason for hiding this comment

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

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.

- Primary use cases tested and reviewed.
- The component has 100% test coverage.
- The default component is available in the Primer Web library in Figma.
Copy link

Choose a reason for hiding this comment

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

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.


## Beta

Expand All @@ -30,13 +31,14 @@ The component meets most maturity criteria, and use is encouraged for most scena
- The design has been reviewed and any resulting issues have been addressed. Systems Designers have reviewed the current implementation, validated its responsive strategy, and how it’s used in production.
- The accessibility team has manually reviewed the component and any outstanding issues have been fixed.
- The component does not introduce unnecessary performance regressions to the user experience or the Primer library.
- All variations of the component are available in the Primer Web library in Figma.

## 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.
Copy link

Choose a reason for hiding this comment

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

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.

- Tooling (such as linters, codemods, etc.) exists to prevent further use of alternatives.

## Deprecated
Expand Down