From 05a7d0bfb8c2c9c51fff74eb78a5936173800ab3 Mon Sep 17 00:00:00 2001 From: Nils Date: Thu, 7 Nov 2024 08:41:44 +0100 Subject: [PATCH] document component lifecycle --- packages/component-library/LIFECYCLE.md | 34 +++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 packages/component-library/LIFECYCLE.md diff --git a/packages/component-library/LIFECYCLE.md b/packages/component-library/LIFECYCLE.md new file mode 100644 index 00000000..990a4b96 --- /dev/null +++ b/packages/component-library/LIFECYCLE.md @@ -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.