创建 issue#

Bug 报告和功能请求在 Bokeh 的 issue 跟踪器中是 Bokeh 中几乎所有改进的基础。Bokeh 的 issue 跟踪器是 Bokeh GitHub 仓库的一部分。

在打开 issue 之前#

作为第一步,您应该始终检查 Bokeh 的 GitHub issue 跟踪器Bokeh Discourse 中是否已有类似或相同的 issue。 有很多 issue,即使在搜索之后也可能错过重复项。如果团队成员将您的 issue 关闭为重复项,您可以随时将您的输入和想法添加到链接的 issue 中。

您要报告的 issue 也可能已在较新版本的 Bokeh 中得到解决。使用 condapip 将 Bokeh 更新到最新的稳定版本,然后尝试重现该 issue。

您可以在提交 issue 时格式化您输入的任何文本。要了解有关格式化选项的更多信息,请参阅 GitHub 上的写作,位于 GitHub 文档中。

Issue 的类型#

Bokeh 的 issue 跟踪器接受两种类型的 issue

Bug 报告

请使用这种类型的 issue 来报告任何无法正常工作的内容。例如,这可能是意外错误、代码中的错误或文档与代码实际行为之间的差异。

功能请求

请使用这种类型的 issue 来提出新功能或任何其他扩展 Bokeh 当前功能的内容。

当您创建新的 issue时,您可以选择创建这两种类型的 issue。当创建任何类型的 issue 时,GitHub 将向您展示一个表单。请仔细按照这些表单中的说明进行操作,并提供所有必要的信息。

注意

Issue 跟踪器不是寻求一般支持的地方。如有问题和技术帮助,请访问 Bokeh Discourse。当您不确定时,请先在 Discourse 上发布问题,然后再打开 issue。

报告 Bug#

提交新的 bug 报告,您应该准备好以下信息。这将有助于尽快解决您的问题

标题

为您的 bug 报告添加一个简短的描述性标题。表单字段已包含 [BUG],请在此之后添加您的标题。

软件版本信息

要查找 Bokeh、Python、IPython 和 Node.js 等软件包的版本,请在安装了 Bokeh 的环境中使用以下命令

bokeh info

或者,也可以使用

from bokeh.util.info import print_info
print_info()

在您的脚本和/或 MRE(最小可重现示例)中。

这将为您提供相关软件包的版本列表。将此信息复制并粘贴到您的 bug 报告中。

Issue 详情

描述您期望的行为以及您实际观察到的行为。

完整、最小、自包含的示例代码,可以重现 issue

提供一个代码示例,该示例遵循 stackoverflow.com 上最小可重现示例的定义。有关更多详细信息,请参阅 matthewrocklin.com 上的 Craft Minimal Bug Reports

堆栈回溯和/或浏览器 JavaScript 控制台输出

可选地,添加任何可能有助于重现和识别 bug 的错误消息或日志。

bug 实际操作的屏幕截图或屏幕录像

如果可能,添加可能有助于理解您的 bug 报告是关于什么的附加信息。例如,这可以是屏幕截图或屏幕录像,用于演示您要提交的 issue 的行为。

功能请求#

提交新的功能请求,您应该准备好以下信息。这将有助于尽快就您提出的功能做出决定

标题

为您的功能请求添加一个简短的描述性标题。表单字段已包含 [FEATURE],请在此之后添加您的标题。

您想要解决的问题的描述

清晰简洁地描述您希望通过建议的功能解决什么问题。

您想要的解决方案的描述

清晰简洁地描述您希望发生什么。

您已考虑的替代方案的描述

清晰简洁地描述您已考虑的任何替代解决方案或功能。

附加背景信息

添加有关您的功能请求的任何附加信息。例如,这可以是屏幕截图或 屏幕录像,用于说明您希望在 Bokeh 中看到的功能。

后续步骤#

当您创建新的 issue 时,GitHub 将自动添加 TRIAGE 标签。

创建 issue 后,Bokeh 核心团队的成员将审核您的 issue 并更新标签。这可能还包括向您请求更多信息。审核 issue 是一个耗时的手动过程,因此请注意,您的 issue 可能需要一段时间才能得到处理。

有关标签和 issue 管理流程的更多信息,请参阅 BEP 1: Issue 和 PR 管理中的“Issue”部分