DBeaver 如何提交 Bug 报告并提供日志与版本信息

DBeaver 如何提交 Bug 报告并提供日志与版本信息

【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver

在使用 DBeaver 时遇到可复现的 bug 或回归问题，需要通过项目仓库的 Issue tracker 提交一份 bug 报告，让开发团队能够复现并定位问题。DBeaver 仓库内置了 bug 报告模板（bug_report.yaml），明确规定了报告必须包含的字段（问题描述、DBeaver 版本）以及建议补充的信息（操作系统、数据库与驱动、复现步骤、日志文件）。本文按照该模板与 CONTRIBUTING.md 的定义，说明从查重、填写必填项到附上日志与版本信息的完整提交路径。

提交前：先确认没有重复的 Issue

创建新 Issue 之前，先做两步检查，这两步都写在仓库文档中：

• CONTRIBUTING.md 要求："Ensure the bug has not already been reported"，即在 Issue tracker 中搜索是否已有相同报告。
• ISSUE_TEMPLATE.md 的头部注释进一步说明：新建 issue 前先查看 DBeaver 文档和 open issues；如果发现相同或相似的 issue，不要创建重复的 issue（do not create issue duplicates），改为在该 issue 下添加评论或投票（vote）。

判断方式很简单：搜索命中相同/相似且仍开放的问题 → 评论或投票后结束；没有命中 → 继续下面的提交流程。

打开 Bug 报告模板并填写必填字段

在仓库的 Issue tracker 中新建 Issue 时，使用由 bug_report.yaml 定义的Bug Report表单。该模板的定位是"Report a reproducible bug or regression in DBeaver"，开头提示 "Please fill in all required fields with as many details as possible"。

模板中校验为必填（required: true）的字段有两个：

1. Description—— 描述你遇到的问题。字段说明允许在此附上日志文件、截图或视频："Attach log files if possible"、placeholder 提示"Please enter a description of the issue. Here you can also attach log files, screenshots or a video"。
2. DBeaver Version—— 你正在运行的 DBeaver 版本。模板 placeholder 给出的格式示例是ex. Community Edition 24.1.0（这是格式示例，需替换为你实际安装的版本）。

提供数据库、驱动、复现步骤与日志信息

模板中其余字段校验为选填（required: false），但模板开头的 "as many details as possible" 意味着应尽量补齐。各字段的内容要求如下：

Operating System（操作系统）：填写操作系统及版本，模板示例为ex. macOS Big Sur 11.5.2。

Database and driver（数据库与驱动）：模板说明可以在连接设置对话框（connection settings dialog）中查看。模板给出的填写格式示例：

1. Database name and version: PostgreSQL 14.0 2. Driver name and version: PostgreSQL JDBC Driver 42.2.25

以上为模板中的示例值，需替换为你的实际数据库名称、版本和 JDBC 驱动名称、版本。

Steps to reproduce（复现步骤）：按模板 placeholder 的写法，逐条列出触发问题的操作，例如模板示例的形式：

1. I try to connect to database '...' 2. With this config '...' 3. I push the button '...' 4. See an error '...'

Additional context（附加环境信息）：模板示例列出两类内容 —— 隧道与代理（Tunnels and proxy: SSH, SOCKS, etc）以及启用的扩展（Extensions: Office extension, Git extension, etc）。如果你的连接使用了 SSH/SOCKS 隧道或安装了扩展，在这里写明。

日志信息的两个要求：

• 模板 Description 字段要求"Attach log files if possible"，并提示可参考项目 wiki 的 "Log-files" 页面了解如何获取日志文件（该获取方法在 wiki 中说明，仓库文档本身不含日志文件的存放路径）。
• 仓库中的另一份模板 ISSUE_TEMPLATE.md 在系统信息一节中把Java version也列为需要提供的信息，并在最后一节明确要求："Include any warning/errors/backtraces from the logs"—— 即报告中应包含从日志中摘录的警告、错误和回溯信息。

也就是说，最低要求是把日志中与问题相关的 warning/error/backtrace 内容写进报告；能拿到完整日志文件时直接作为附件上传。

提交后：如何确认报告已进入处理队列

模板定义中写明了新建 issue 的自动标签：labels: [wait for review]。提交后在 Issue 页面确认存在wait for review标签，说明该 ticket 已进入等待团队审查的队列（README.md 顶部也以 "wait for review" 标签统计正在审查中的 tickets）。

如果希望提高 ticket 的优先级，README 给出了官方方式：在该 ticket 描述下用 👍 投票（"To promote a ticket to a higher priority - please vote for it with 👍 under the ticket description"）。

范围与限制

• 该模板的适用范围是可复现的 bug 或回归问题（模板 description 原文），不可复现的偶发现象不属于该模板设计的目标场景，但可以在 Description 中尽量描述已知条件。
• 日志文件的具体存放位置和导出方法由项目 wiki 的 "Log-files" 页面说明，仓库文档中没有给出，本文不补充未经文档确认的路径。
• 社区版（Community Edition）的支持渠道只有两个：DBeaver WIKI 与 Issue tracker（见 SUPPORT.md），bug 报告应通过 Issue tracker 提交。

【免费下载链接】dbeaverFree universal database tool and SQL client项目地址: https://gitcode.com/GitHub_Trending/db/dbeaver