diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml index 5baaa9f5..06b918ee 100644 --- a/.github/ISSUE_TEMPLATE/01-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -1,15 +1,69 @@ name: 问题反馈 -description: 软件问题反馈 +description: 报告可复现的软件问题,并提供定位所需的环境与数据源信息 title: "[Bug] " labels: ["bug"] body: + - type: markdown + attributes: + value: | + 感谢反馈。请尽量完整填写以下信息;缺少数据源类型、版本或复现步骤时,维护者可能无法定位问题。 + + **请勿提交密码、Token、完整连接串、私钥或包含业务数据的截图/日志。** + - type: checkboxes id: searched attributes: - label: 已经搜索过 Issues,未发现重复问题* + label: 提交前确认 options: - label: 我已经搜索过 Issues,没有发现重复问题 + required: true + - label: 我已经移除或脱敏密码、Token、连接串、私钥和业务数据 + required: true + validations: + required: true + + - type: dropdown + id: area + attributes: + label: 问题所属功能 + description: 请选择最接近问题发生位置的功能 + options: + - 数据源连接、认证或网络 + - 数据库、Schema、表、视图、索引等对象管理 + - SQL 编辑、执行或结果集 + - 表数据浏览或编辑 + - Redis、MongoDB、消息队列、向量或搜索数据 + - 导入、导出或备份 + - SSH、代理或隧道 + - 驱动或 Driver Agent + - AI、MCP 或 Agent + - 安装、更新或启动 + - 界面、交互或本地设置 + - 性能、卡顿或崩溃 + - 其他 + validations: + required: true + + - type: input + id: version + attributes: + label: GoNavi 版本 + description: 请填写“关于”页面显示的完整版本;开发构建请同时提供 commit + placeholder: "例如:v0.9.0 / dev build (commit abc1234)" + validations: + required: true + + - type: dropdown + id: installation + attributes: + label: 安装或运行方式 + options: + - GitHub Release 安装包 + - GitHub Release 便携版或压缩包 + - 源码开发模式 + - 自行构建 + - 其他 validations: required: true @@ -17,37 +71,104 @@ body: id: system attributes: label: 操作系统及版本 - placeholder: Windows 10 22H2 / macOS Mojave / Linux + description: 请同时提供系统版本和 CPU 架构 + placeholder: "例如:Windows 11 24H2 x64 / macOS 15.5 arm64 / Ubuntu 24.04 x64" validations: required: true - type: input - id: version + id: datasource attributes: - label: 软件安装版本 - placeholder: v0.2.3 + label: 数据源类型及版本 + description: 涉及数据源的问题必须填写类型、服务端版本和兼容模式;与数据源无关时填写“不适用” + placeholder: "例如:MySQL 8.0.36 / OceanBase 4.3(MySQL 模式)/ Redis 7.2 Cluster" + validations: + required: true + + - type: input + id: datasource_environment + attributes: + label: 数据源部署形态 + description: 可填写单机、主从、集群、云服务、Docker,以及使用的 Driver Agent/自定义驱动版本 + placeholder: "例如:Docker 单机 / Redis Cluster 3 主 3 从 / 阿里云 RDS" + + - type: dropdown + id: connection + attributes: + label: 连接方式 + description: 可多选;与数据源无关时选择“不适用” + multiple: true + options: + - 直连 + - SSH 隧道 + - HTTP 隧道 + - 系统或自定义代理 + - TLS/SSL + - 不适用 validations: required: true - type: textarea id: description attributes: - label: 问题简述及复现流程 - description: 请详细描述你遇到的问题,并提供复现步骤 + label: 问题描述 + description: 请说明问题发生的页面、对象或操作,以及稳定出现还是偶发 placeholder: | - 1. 打开软件 - 2. 点击 xxx - 3. 预期结果是 ... - 4. 实际结果是 ... - 5. 截图 ... + 在哪个页面或功能中发生? + 操作的对象是什么(数据库/Schema/表/索引/Key 等)? + 每次都能复现,还是偶发? validations: required: true + - type: textarea + id: reproduction + attributes: + label: 最小复现步骤 + description: 请从启动 GoNavi 或连接数据源开始,按顺序列出可重复操作的步骤 + placeholder: | + 1. 连接到 ... + 2. 打开 ... + 3. 点击/执行 ... + 4. 观察到 ... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: 期望行为 + placeholder: 描述你认为正确的结果 + validations: + required: true + + - type: textarea + id: actual + attributes: + label: 实际行为 + description: 请粘贴完整错误信息,不要只填写“报错”或错误截图 + placeholder: 描述实际结果,并粘贴完整错误文本 + validations: + required: true + + - type: textarea + id: logs + attributes: + label: 相关日志 + description: 请粘贴问题发生前后的相关日志;提交前务必脱敏 + render: shell + + - type: textarea + id: screenshots + attributes: + label: 截图或录屏 + description: 可直接拖入截图或录屏;请遮盖连接信息、账号和业务数据 + placeholder: 可选 + - type: textarea id: extra attributes: label: 其他补充 - description: 如果你有额外信息,请在此填写 + description: 可提供同一数据源在其他客户端的对照结果、临时规避方式等 placeholder: 可选 - type: checkboxes