创建问题#
Bokeh的问题跟踪器中的错误报告和功能请求是几乎所有在Bokeh中实现的改进的基础。Bokeh的问题跟踪器是Bokeh GitHub仓库的一部分。
在提交问题之前#
作为第一步,你应该始终检查 Bokeh的GitHub问题跟踪器和 Bokeh Discourse以查找类似或相同的问题。有很多问题, 即使搜索后也可能错过重复的问题。如果团队成员 将你的问题标记为重复并关闭,你仍然可以在链接的问题中添加你的意见和想法。
您想要报告的问题可能已经在Bokeh的较新版本中得到解决。请使用conda或pip将Bokeh更新到最新的稳定版本,并尝试重现该问题。
您可以在提交问题时格式化您输入的任何文本。要了解更多关于格式化选项的信息,请参阅在GitHub上写作中的GitHub文档。
问题类型#
Bokeh的问题跟踪器接受两种类型的问题:
- Bug report
请使用此类问题报告任何未按预期工作的情况。这可能是意外的错误、代码中的故障,或者文档与代码实际行为之间的差异,例如。
- Feature request
请使用此类问题来提出新功能或任何其他扩展Bokeh当前功能的建议。
当您创建新问题时,您可以选择创建这两种类型的问题。在创建任何一种类型的问题时,GitHub 将向您展示一个表单。请仔细遵循这些表单中的说明,并提供所有必要的信息。
注意
问题跟踪器不适用于一般支持。如需提问和技术帮助,请访问Bokeh Discourse。当您不确定时,请先在Discourse上提问,然后再提交问题。
报告错误#
要提交新的错误报告,您应准备好以下信息。 这将有助于尽快解决您的问题:
- Title
为您的错误报告添加一个简短的描述性标题。表单字段已经包含
[BUG]
,请在其后添加您的标题。- Software version info
要查找诸如Bokeh、Python、IPython和Node.js等包的版本,请在已安装Bokeh的环境中使用以下命令:
bokeh info
或者使用:
from bokeh.util.info import print_info print_info()
在你的脚本和/或MREs(最小可复现示例)中。
这为您提供了相关软件包版本的列表。 将此信息复制并粘贴到您的错误报告中。
- Issue details
描述您期望的行为和您实际观察到的行为。
- Complete, minimal, self-contained example code that reproduces the issue
提供一个遵循 stackoverflow.com上最小可重现示例定义的代码示例。 更多详情,请参阅matthewrocklin.com上的编写最小错误报告。
- Stack traceback and/or browser JavaScript console output
可选地,添加任何可能有助于重现和识别错误的消息或日志。
- Screenshots or screencasts of the bug in action
如果可能,请添加可能有助于理解您的错误报告的其他信息。这可以是截图或屏幕录像,例如,展示您正在提交问题的行为。
功能请求#
要提交新的功能请求,您应准备好以下信息。这将有助于尽快对您提出的功能做出决定:
- Title
为您的功能请求添加一个简短的描述性标题。表单字段已经包含
[FEATURE]
,请在其后添加您的标题。- Description of the problem you’d like solved
清晰简洁地描述您希望通过建议的功能解决的问题。
- Description of the solution you’d like
清晰简洁地描述您希望发生的事情。
- Description of alternatives you’ve considered
对您考虑过的任何替代解决方案或功能的清晰简洁的描述。
- Additional context
添加任何关于您功能请求的额外信息。这可以是截图或屏幕录像,例如说明您希望在Bokeh中看到的功能。
下一步#
当你创建一个新问题时,GitHub 会自动添加标签 TRIAGE
。
一旦你创建了一个问题,Bokeh核心团队的成员将会审查你的问题并更新标签。这也可能包括向你请求更多信息。审查问题是一个耗时的、手动处理的过程,所以请注意,你的问题可能需要一段时间才能被处理。
请参阅BEP 1: 问题和PR管理中的“问题”部分以获取更多关于标签和问题管理流程的信息。