社区提问规范

Viewed 16

为了更快,更容易的帮助你定位问题,请按照如下规范提交提问。

版本信息
因为有些问题仅在特定版本下才会发生,所以提供使用的 ONES、能力包 的版本信息

环境信息
因为有些问题仅在特定环境下才会发生,所以提供你的电脑环境,如 Windows 10、Chrome 66.11 等

重现示例
所谓『重现』,就是一段可以运行并展示一个 bug 如何发生的代码。

文字是不够的
如果你遇到一个问题,但是只提供了一些文字描述,我们是不可能修复这个 bug 的。首先,文字在描述技术问题时的表达难度和不精确性;其次,问题的真实原因有很多可能,它完全有可能是一个你根本没有提及的因素导致的。重现是唯一能够可靠地让我们理解问题本质的方式。

重现必须是可运行的
截图和视频不是重现。它们仅仅证明了 bug 的存在,但却不能提供关于 bug 是如何发生的信息。只有可运行的代码提供了完整的上下文,并让我们可以进行真正的 debug 而不是空想和猜测。当然,在提供的重现的前提下,视频或是 gif 动画可以帮助解释一些比较难用文字描述的交互行为。

重现应当尽量精简
一个最小化的重现意味着它精确地定位了 bug 本身 - 它应当只包含能够触发 bug 的最少量的代码。你应当尽可能地剔除任何跟该 bug 无关的部分。

重现步骤
你应该简单明了的描述我们要如何操作示例,才能重现你说的问题。
如:
1、点击按钮A
2、点击按钮B
3、查看控制台日志

期望的结果是什么
如:期望控制台输出 2

实际的结果是什么
如:实际输出是 1

其它信息
如果以上信息不足以描述你的问题,可以在此处描述

0 Answers