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.

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

Jump to bottom

document component lifecycle #368

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −0
Open

document component lifecycle #368

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
34 changes: 34 additions & 0 deletions packages/component-library/LIFECYCLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Component lifecycle

To have a more stable and predictable package.

There are three stages: Future, Stable and Deprecated

## Future

In this stage, we test new ideas and gather feedback, so please [create an issue](https://github.com/shopware/meteor/issues/new/choose) to share yours.

If a component isn't helpful, we skip moving it to Stable and remove it in the next release.

During this stage we allow ourselves to make breaking changes without notice beforehand.

## Stable

You can use the component in production.

Requirements for the Stable stage:

- We covered the component with automated tests
- It makes use of the Meteor Design Tokens
- It meets the WCAG 2.1 AA level
- It has documentation in form of Storybook Stories

We document breaking changes at least one patch version before a major release.

## Deprecated

The component got deprecated, and we discourage you from using the component.

If there is an alternative way, we provide you with an upgrade guide.

Once a component got deprecated, we will remove it in the next major version.
Loading