错误分类指南

此页面描述了处理godot上的问题和请求时Bug分类团队的典型工作流,即Bugsquad。 GitHub 存储库。它必然会与Bugsquad一起发展,因此请毫不犹豫地提出对以下准则的修改。

问题管理

Github提出了各种功能来管理问题:

  • 从预定义列表中设置一个或多个标签

  • 从预定义列表中设置一个里程碑

  • 在项目仪表板中跟踪问题

  • 将一个贡献者定义为godot引擎组织成员中的“受让人”

由于Github上的Godot引擎组织目前的贡献者数量有限,因此目前我们不广泛使用被分配者。在问题通知单上提到任何问题和/或与其他开发人员讨论解决问题的最佳方法后,如果相关,欢迎所有贡献者处理任何问题。

目前,我们也不使用项目仪表板功能。

我们尽量为问题和请求分配标签(和里程碑,如果相关的话)。

标签

以下标签当前在godot存储库中定义:

类别:

  • 归档的 :其他问题的副本,或无效。这样的问题也将被解决。

  • Bug :描述的内容工作不正常。

  • 已确认 :已由Bug报告程序以外的至少一个贡献者确认(通常用于 Bug 报告)。这个标签的目的是让开发人员知道,当他们想要选择要处理的问题时,哪些问题仍然是可复制的。因此,最好在评论中添加一条评论,说明什么平台、什么版本或提交的godot可以复制该问题;如果一年后开发人员查看该问题,那么 已确认 标签可能不再相关。

  • 讨论 :这个问题不是一致同意的,需要进一步讨论来确定应该做什么来解决这个主题。

  • 文档 :与文档相关的问题。主要是在API文档中请求增强。与已阅读的OCS文档相关的问题应在 godot-docs 储存库。

  • 增强 :描述对现有功能的建议增强。

  • 功能建议 :描述要实现新功能的愿望。

  • 初级工作 :问题是 假设 作为一个容易修复的代码库,这使得它非常适合需要熟悉代码库的初级贡献者。

  • 需要重新平衡 :此问题需要合并git-rebase。

  • 需要测试 :无法完全测试问题/请求,因此需要进一步测试。这可能意味着它需要在不同的硬件/软件配置上进行测试,甚至复制的步骤也不确定。

  • PR welcome / hero wanted! :特别欢迎为这些标签的问题作出贡献。注意这个 意味着没有这些标签你就不能处理问题。

  • 跟踪器 :用于跟踪其他问题的问题(如与插件系统相关的所有问题)。

  • 可用性 :直接影响用户可用性的问题。

这些类别用于对问题进行一般分类。它们可以在相关情况下以某种方式组合,例如,可以标记问题 增强可用性 同时,如果这是提高可用性的问题。或 功能建议讨论 如果这是一个非协商一致的特性请求,或者是一个不够精确的请求。

话题:

  • 资产负债表 :与资源库的问题相关。

  • 音频 :与音频功能(低电平和高电平)有关。

  • 建筑系统 :与构建问题相关,或者与scons构建系统相关,或者与编译器特性相关。

  • Core :与核心引擎有关的任何内容。因为这是一个相当大的主题,所以稍后可能会进一步划分。

  • 驱动程序 :与引擎使用的驱动程序有关。

  • 编辑 :与编辑器中的问题(主要是UI)相关。

  • GDNative :与GDNative模块相关。

  • GDScript :与gdscript相关。

  • Mono :与C# /Mono绑定相关。

  • 网络 :与网络相关。

  • 物理 :与物理引擎(2D/3D)相关。

  • 插件 :与编写插件时遇到的问题有关。

  • 移植 :与某些特定平台相关。

  • 致使 :与二维和三维渲染引擎相关。

  • VisualScript :与可视化脚本语言有关。

问题通常只对应一个主题,尽管看到符合两个法案的问题并非不可想象。一般的想法是,在所有主题后面都会有专门的贡献者团队,因此他们可以将注意力集中在标有其团队主题的问题上。

平台:

安卓HTML5iOSLinux系统macOSWindowsUWP

默认情况下,假定给定问题适用于所有平台。如果使用其中一个平台标签,那么它是独占的,以前的假设不再存在(因此,如果它是Android和Linux上的bug,请选择这两个平台)。

里程碑

Milestones 对应于Godot的计划未来版本,该版本有现有的路线图。符合上述路线图的问题应在相应的里程碑下归档;如果不符合任何当前路线图,则应将其保留为无里程碑。根据经验,如果一个问题涉及到里程碑中的新特性,或者在未来任何稳定版本中都无法接受的关键bug,或者Juan现在想要处理的任何问题,那么它就对应于一个给定的里程碑。

贡献者可以自由选择问题,不管他们分配的里程碑是什么;如果一个错误被认为不是紧急的,因此没有里程碑,那么它可能仍然是非常受欢迎的。