创建重现
可重现的测试用例可以帮助你隔离问题的根源,这是解决问题的第一步!本页概述了如何设置创建重现。
为什么要创建重现?
可重现的测试用例是共享导致错误的一组特定条件的绝佳方式。它允许维护人员和社区验证、缩小问题的范围并帮助你解决问题。
先决条件
确保你已
- 在你的本地开发机器上安装了
Yarn
。 - 用于托管重现代码的 GitHub 帐户。
- 用于发布 Storybook 的 Chromatic 帐户。
初始设置
首先,打开一个终端并运行以下命令
你可以在命令中附加一个模板名称以获取过滤后的结果(例如,npx storybook@next sandbox react
)。
接下来,选择你要使用的模板
最后,输入重现的存储位置
如果你没有为重现提供完整路径,它将在当前目录中生成。
如果一切按预期工作,你应该在本地环境中设置好一个功能完备的 Storybook。
第三方依赖项和附加组件
在添加代码之前,安装和配置任何必要的包。例如,如果你在 CSS 框架(例如,Tailwind)方面遇到问题,你应该安装和配置它。
安装和配置任何与问题相关的 Storybook 附加组件(例如,@storybook/addon-a11y
)。
添加故事
任何 Storybook 重现都需要包含 故事。为了帮助你更快地解决问题,我们鼓励你包含最少的故事,这些故事将复制你的问题。
托管
完成工作后,你需要托管你的重现。首先登录 GitHub.com 并创建一个 新仓库。
然后,按照 GitHub 的说明设置仓库。
不要忘记将 your-username
替换为你自己的帐户名称。
发布
检查您的重现的一个好方法是将其在线部署。我们推荐Chromatic,这是一个由 Storybook 维护人员创建的免费发布服务。它允许您在云中安全可靠地部署和托管您的重现。
使用 Chromatic 时有用的资源
提交问题
最后,在 Storybook 问题跟踪器 中创建您的问题,按照要求的步骤进行,并提供问题的详细描述。添加 GitHub 存储库和 部署的重现 来帮助进行分类过程。