组件生命周期
北极星组件在整个生命周期中经历一系列阶段。在每个阶段中,组件必须满足一组需求。
反馈和建议
有反馈、问题或建议吗?制造问题在组件生命周期的任何阶段。
α
该组件是一个正在进行的工作,可以进行探索性使用,预计会有突破性的更改。在这个阶段,我们对理解组件的目的以及它试图解决什么问题非常重要。如果目的不明确,我们可能决定不继续使用该组件,并且可以在没有警告的情况下删除它。
alpha的要求
- 有一个明确的目的和理由,为什么它属于北极星
- 使用北极星令牌不引用任何硬编码的静态值
- 设计时考虑到响应性,可以适应断点
- 满足已知的可访问性要求如:对比度,交互状态,触摸目标大小等。
- 在进度文件中存在,包括一些例子的道具列表
- 文档包括Storybook中的示例
- 该组件具有100%的测试覆盖率
alpha阶段会发生什么
- 正在评估使用情况,可能不会升级到beta版。评估包括任何必要的研究和数据,支持为什么组件属于北极星。
- 组件可以完全改变,或者从系统中移除
- 强烈建议和鼓励反馈,制造问题
β
一旦对问题有了清晰的理解,并且我们对解决方案有信心,组件就会进入beta版。此阶段的重点是在足够的环境中进行测试,以确保组件没有错误。
准备广泛采用,鼓励在大多数情况下。在较小的版本更新中可能会有破坏性的更改。
beta的要求
- 在生产中多次使用(Shopify管理)
- 符合所有可访问性我们用例的需求
- 使用指南和文档涵盖了常见的用例
- 由设计人员和开发人员在生产中审查和测试
- Figma组件可在北极星组件文件
测试期间会发生什么
- 正在进行迁移到稳定的工作
- 人工和自动迁移指导正在进行中
稳定的
该组件没有错误,并且可以在大多数(如果不是所有的话)环境中工作。它已经准备好全面采用,并有望获得长期支持。
稳定性要求
- API是稳定的,直到下一个主要版本(如果有必要)之前都没有破坏性的更改。
- 关于UX和DX的可用性测试和反馈已经收集
- 存在关于组件道具、变量、可访问性指南和用法的文档
- 存在手动和自动迁移文档
遗产
该组件是稳定的,并且至少在过去的一个主要发行版中得到了支持,但是计划用一个新组件或新组件的组合来取代其功能。不鼓励使用遗留组件,但要注意的是,它将在下一个主要版本中被弃用和替换。
遗留组件的需求
- 遗留组件的文档已经存在,其中包括任何可选组件
- 弃用日期已经宣布,并且距离弃用组件的包的发布日期至少有一个月的时间
- 手动和自动迁移路径都有文档记录,并且至少一个月前就可用了
弃用
该组件将被删除,应该避免使用。
弃用要求
- 有关于弃用的文档,其中包括任何可选组件
- 该组件在使用时包含弃用警告
- 删除日期已经宣布,并且距离删除组件的包的发布日期至少有一个月的时间
- 手动和自动迁移路径都有文档记录,并且至少一个月前就可用了