创建问题#
Bokeh 问题跟踪器中的错误报告和功能请求是 Bokeh 中几乎所有实现的改进的基础。 Bokeh 的问题跟踪器 是 Bokeh GitHub 存储库的一部分。
在打开问题之前#
第一步,您应该始终检查 Bokeh 的 GitHub 问题跟踪器 和 Bokeh Discourse 中是否存在类似或相同的问题。存在很多问题,即使搜索后也可能错过重复项。如果团队成员将您的问题关闭为重复项,您始终可以将您的输入和想法添加到链接的问题中。
您要报告的问题也可能已在 Bokeh 的较新版本中得到解决。使用 conda 或 pip 将 Bokeh 更新到最新的稳定版本,然后尝试重现该问题。
您可以在提交问题时格式化输入的任何文本。要了解有关格式选项的更多信息,请参阅 GitHub 文档中的 在 GitHub 上写作。
问题类型#
Bokeh 的问题跟踪器接受两种问题类型
- 错误报告
请使用此类问题报告任何无法按预期工作的情况。例如,这可能是意外错误、代码故障或文档与代码实际行为之间的差异。
- 功能请求
请使用此类问题提出新功能或任何其他扩展 Bokeh 当前功能的内容。
当您 创建新问题 时,您可以选择在这两种问题类型之间创建。创建任一类型的问题时,GitHub 将向您显示一个表单。请仔细按照这些表单中的说明操作,并提供所有必要的信息。
注意
问题跟踪器不是用于一般支持的地方。如需疑问和技术帮助,请访问 Bokeh Discourse。如果您不确定,请先在 Discourse 中发布问题,然后再打开问题。
报告错误#
要 提交新的错误报告,您应该准备好以下信息。这将有助于尽快解决您的问题
- 标题
为您的错误报告添加简短的描述性标题。表单字段已包含
[BUG]
,在之后添加您的标题。- 软件版本信息
要查找 Bokeh、Python、IPython 和 Node.js 等软件包的版本,请在安装了 Bokeh 的环境中使用以下命令
bokeh info
或者,使用
from bokeh.util.info import print_info print_info()
在您的脚本和/或 MRE(最小可重现示例)中。
这将为您提供相关软件包版本的列表。复制并粘贴此信息到您的错误报告中。
- 问题详情
描述您期望的行为和观察到的行为。
- 可重现问题的完整、最小、独立的示例代码
提供遵循 stackoverflow.com 上最小可重现示例的定义 的代码示例。有关更多详细信息,请参阅 matthewrocklin.com 上的编写最小错误报告。
- 堆栈跟踪和/或浏览器 JavaScript 控制台输出
可选地,添加可能有助于重现和识别错误的任何错误消息或日志。
- 错误操作的屏幕截图或屏幕录制
如果可能,添加可能有助于理解您的错误报告内容的其他信息。例如,这可能是屏幕截图或 屏幕录制,用于演示您要提交问题所涉及的行为。
功能请求#
要 提交新的功能请求,您应该准备好以下信息。这将有助于尽快对您提出的功能做出决定
- 标题
为您的功能请求添加简短的描述性标题。表单字段已包含
[FEATURE]
,在之后添加您的标题。- 您想要解决的问题的描述
清楚简洁地描述您想要使用建议的功能解决什么问题。
- 您想要实现的解决方案的描述
清楚简洁地描述您希望发生什么。
- 您考虑过的替代方案的描述
清楚简洁地描述您考虑过的任何替代解决方案或功能。
- 其他上下文
添加有关您的功能请求的任何其他信息。例如,这可能是屏幕截图或 屏幕录制,用于说明您希望在 Bokeh 中看到的的功能。
后续步骤#
创建新问题时,GitHub 会自动添加标签 TRIAGE
。
创建问题后,Bokeh 核心团队 的成员将审查您的问题并更新标签。这可能还包括向您索取更多信息。审查问题是一个耗时的手动过程,因此请注意,您的问题可能需要一段时间才能得到处理。
有关标签和问题管理流程的更多信息,请参阅 BEP 1:问题和 PR 管理中的“问题”部分。