chore: simplify issue templates to reduce required fields
This commit is contained in:
parent
49dc85267a
commit
07c1948ff8
|
|
@ -6,79 +6,14 @@ body:
|
|||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢反馈。请尽量提供可复现的信息,尤其是数据库类型、版本、连接方式和错误日志。涉及敏感信息时请脱敏。
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 提交前确认
|
||||
options:
|
||||
- label: 我已搜索现有 issues,确认没有重复反馈。
|
||||
required: true
|
||||
- label: 我已尝试使用最新版本或当前 main 分支复现。
|
||||
required: false
|
||||
- label: 我提供的信息中不包含真实密码、Token、私钥或生产数据。
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: 问题模块
|
||||
description: 选择最接近的功能区域。
|
||||
options:
|
||||
- 连接管理
|
||||
- SSH 隧道
|
||||
- 结构浏览
|
||||
- SQL 查询编辑器
|
||||
- 数据表格 / 行内编辑
|
||||
- 数据导出
|
||||
- Redis 浏览器
|
||||
- MongoDB 浏览器
|
||||
- 查询历史
|
||||
- AI 助手
|
||||
- 主题 / 多语言 / 界面
|
||||
- 安装 / 启动 / 打包
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: database
|
||||
attributes:
|
||||
label: 数据库类型
|
||||
description: 如果与数据库无关,请选择“不适用”。
|
||||
multiple: true
|
||||
options:
|
||||
- MySQL
|
||||
- PostgreSQL
|
||||
- SQLite
|
||||
- Redis
|
||||
- MongoDB
|
||||
- DuckDB
|
||||
- ClickHouse
|
||||
- SQL Server
|
||||
- 不适用
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
感谢反馈。涉及敏感信息请脱敏。请尽量提供数据库类型、版本和错误日志。
|
||||
|
||||
- type: input
|
||||
id: database-version
|
||||
id: database
|
||||
attributes:
|
||||
label: 数据库版本
|
||||
description: 例如 MySQL 8.0.36、PostgreSQL 16、Redis 7.2、MongoDB 7.0。
|
||||
label: 数据库类型和版本
|
||||
description: 例如 PostgreSQL 16、MySQL 8.0、Redis 7.2。
|
||||
placeholder: "例如:PostgreSQL 16.2"
|
||||
|
||||
- type: dropdown
|
||||
id: connection-method
|
||||
attributes:
|
||||
label: 连接方式
|
||||
options:
|
||||
- 直连
|
||||
- SSH 隧道
|
||||
- 本地文件 / SQLite
|
||||
- 不适用
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
|
@ -86,70 +21,23 @@ body:
|
|||
id: description
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 简洁说明实际发生了什么,以及它为什么不符合预期。
|
||||
placeholder: "例如:连接 PostgreSQL 后展开 schema 时一直 loading,控制台报错 ..."
|
||||
description: 发生了什么?希望发生什么?
|
||||
placeholder: "例如:连接 PostgreSQL 后一直 loading,没有错误提示,期望能正常展开 schema。复现步骤:1. 新建连接 2. 填写信息 3. 点击保存..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: 复现步骤
|
||||
description: 请写出从启动 DBX 到出现问题的最短路径。
|
||||
placeholder: |
|
||||
1. 打开 DBX
|
||||
2. 新建 PostgreSQL 连接,填写 ...
|
||||
3. 点击测试连接 / 保存 / 展开表
|
||||
4. 出现 ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 期望行为
|
||||
placeholder: "例如:应该正常展开 public schema 并显示表列表。"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: 实际行为
|
||||
placeholder: "例如:界面无响应 / 弹出错误 / 数据显示为空 / 应用崩溃。"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: sample
|
||||
attributes:
|
||||
label: 最小复现 SQL / 数据结构
|
||||
description: 如果问题和查询、表结构、Redis key、MongoDB document 有关,请提供脱敏后的最小样例。
|
||||
render: sql
|
||||
placeholder: |
|
||||
CREATE TABLE demo (...);
|
||||
SELECT ...;
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: 错误日志
|
||||
description: 粘贴终端、DevTools、Tauri/Rust 日志。
|
||||
description: 终端、DevTools 或应用内的错误信息。
|
||||
render: shell
|
||||
placeholder: "请粘贴错误堆栈或控制台输出。"
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: 截图
|
||||
description: 可直接粘贴或拖入截图。
|
||||
|
||||
- type: input
|
||||
id: app-version
|
||||
attributes:
|
||||
label: DBX 版本 / Commit
|
||||
description: Release 版本号、安装包版本或 git commit。
|
||||
placeholder: "例如:v0.1.0 / main@abcdef1"
|
||||
label: DBX 版本
|
||||
placeholder: "例如:v0.1.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
|
@ -159,12 +47,9 @@ body:
|
|||
label: 操作系统
|
||||
multiple: true
|
||||
options:
|
||||
- macOS Apple Silicon
|
||||
- macOS Intel
|
||||
- Windows x64
|
||||
- Windows ARM64
|
||||
- Linux x64
|
||||
- Linux ARM64
|
||||
- macOS
|
||||
- Windows
|
||||
- Linux
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
|
@ -173,4 +58,4 @@ body:
|
|||
id: extra
|
||||
attributes:
|
||||
label: 补充信息
|
||||
description: 例如是否使用代理、VPN、Docker 数据库、远程云数据库、特殊字符账号或非默认端口。
|
||||
description: 截图、SQL 样例、连接方式、特殊环境等。
|
||||
|
|
|
|||
|
|
@ -1,129 +1,44 @@
|
|||
name: 数据库适配 / 兼容性问题
|
||||
description: 某个数据库、版本、驱动行为、SQL 方言或元数据读取不兼容。
|
||||
name: 数据库兼容性问题
|
||||
description: 某个数据库、版本或 SQL 方言不兼容。
|
||||
title: "[Compatibility] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
这个模板用于收集数据库兼容性细节,例如某个版本连接失败、schema 读取不完整、字段类型显示错误、SQL 方言不支持等。请勿提交真实连接凭据。
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 提交前确认
|
||||
options:
|
||||
- label: 我已确认连接信息、网络、账号权限本身可用。
|
||||
required: true
|
||||
- label: 我已隐藏真实主机、用户名、密码、Token 和业务数据。
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: database
|
||||
attributes:
|
||||
label: 数据库类型
|
||||
options:
|
||||
- MySQL
|
||||
- PostgreSQL
|
||||
- SQLite
|
||||
- Redis
|
||||
- MongoDB
|
||||
- DuckDB
|
||||
- ClickHouse
|
||||
- SQL Server
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
用于收集数据库兼容性细节,例如连接失败、schema 读取不完整、字段类型显示错误等。请脱敏。
|
||||
|
||||
- type: input
|
||||
id: database-version
|
||||
id: database
|
||||
attributes:
|
||||
label: 数据库版本 / 发行版
|
||||
description: 例如 MariaDB、AWS RDS、Azure SQL、TiDB、兼容 PostgreSQL 的云数据库等也请注明。
|
||||
placeholder: "例如:MariaDB 10.11 / AWS RDS PostgreSQL 15.5"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: scenario
|
||||
attributes:
|
||||
label: 问题场景
|
||||
options:
|
||||
- 测试连接失败
|
||||
- 保存连接失败
|
||||
- SSH 隧道连接失败
|
||||
- 展开数据库 / schema / 表失败
|
||||
- 字段 / 索引 / 外键 / 触发器读取错误
|
||||
- 查询执行错误
|
||||
- 查询结果显示错误
|
||||
- 行内编辑 / 保存错误
|
||||
- Redis key 浏览 / value 显示错误
|
||||
- MongoDB document 浏览 / CRUD 错误
|
||||
- 其他
|
||||
label: 数据库类型和版本
|
||||
description: 也请注明发行版,如 MariaDB、AWS RDS、TiDB 等。
|
||||
placeholder: "例如:MariaDB 10.11"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: schema
|
||||
id: description
|
||||
attributes:
|
||||
label: 最小表结构 / 数据样例
|
||||
description: 请提供能触发问题的最小结构或数据,务必脱敏。
|
||||
render: sql
|
||||
placeholder: |
|
||||
CREATE TABLE ...
|
||||
INSERT INTO ...
|
||||
|
||||
- type: textarea
|
||||
id: query
|
||||
attributes:
|
||||
label: 触发问题的查询 / 操作
|
||||
description: 如果和 SQL、Redis 命令、MongoDB 查询有关,请贴出最小复现内容。
|
||||
render: sql
|
||||
label: 问题描述
|
||||
description: 什么操作,出了什么错,期望怎样?
|
||||
placeholder: "例如:展开 schema 时报错 'unknown type',期望能正常显示字段。"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: error
|
||||
attributes:
|
||||
label: 错误信息
|
||||
description: 粘贴 DBX 弹窗、终端、DevTools 或后端日志里的错误。
|
||||
render: shell
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: 截图
|
||||
description: 可直接粘贴或拖入截图。
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 正确行为
|
||||
description: 说明同样操作在数据库 CLI、其他客户端或预期中应该得到什么结果。
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: app-version
|
||||
attributes:
|
||||
label: DBX 版本 / Commit
|
||||
placeholder: "例如:v0.1.0 / main@abcdef1"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: 操作系统
|
||||
multiple: true
|
||||
options:
|
||||
- macOS Apple Silicon
|
||||
- macOS Intel
|
||||
- Windows x64
|
||||
- Windows ARM64
|
||||
- Linux x64
|
||||
- Linux ARM64
|
||||
- 其他
|
||||
label: DBX 版本
|
||||
placeholder: "例如:v0.1.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
|
@ -131,4 +46,4 @@ body:
|
|||
id: extra
|
||||
attributes:
|
||||
label: 补充信息
|
||||
description: 例如数据库部署方式、Docker 镜像、字符集、时区、SSL、代理、VPN、云厂商兼容层等。
|
||||
description: 表结构、SQL 样例、截图、部署方式(Docker/云/自建)等。
|
||||
|
|
|
|||
|
|
@ -1,71 +1,19 @@
|
|||
name: 功能建议
|
||||
description: 提议新功能、交互改进、性能优化或现有功能增强。
|
||||
description: 提议新功能、交互改进或现有功能增强。
|
||||
title: "[Feature] "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
好的功能建议最好说明使用场景、当前痛点和期望工作流。请尽量避免只写“支持 X”,多给一点上下文会更容易评估和实现。
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 提交前确认
|
||||
options:
|
||||
- label: 我已搜索现有 issues,确认没有重复建议。
|
||||
required: true
|
||||
- label: 这个建议与 DBX 的数据库管理、查询、浏览、导出或桌面体验有关。
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: 建议类型
|
||||
options:
|
||||
- 新数据库支持
|
||||
- 连接管理
|
||||
- SSH 隧道
|
||||
- 结构浏览
|
||||
- SQL 编辑器 / 自动补全
|
||||
- 数据表格 / 编辑体验
|
||||
- 数据导入导出
|
||||
- Redis 功能
|
||||
- MongoDB 功能
|
||||
- 查询历史
|
||||
- AI 助手
|
||||
- 主题 / 多语言 / 界面
|
||||
- 性能优化
|
||||
- 安装 / 打包 / 更新
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: database
|
||||
attributes:
|
||||
label: 相关数据库
|
||||
multiple: true
|
||||
options:
|
||||
- MySQL
|
||||
- PostgreSQL
|
||||
- SQLite
|
||||
- Redis
|
||||
- MongoDB
|
||||
- DuckDB
|
||||
- ClickHouse
|
||||
- SQL Server
|
||||
- 不限数据库
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
好的建议最好说明使用场景和期望效果。请尽量避免只写“支持 X”。
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: 当前痛点
|
||||
description: 现在做这件事有什么不方便、不能做或容易出错?
|
||||
placeholder: "例如:每次查询后都要手动复制结果再转成 Markdown,流程比较繁琐。"
|
||||
description: 现在做这件事有什么不方便?
|
||||
placeholder: "例如:每次查询后都要手动复制结果再转成 Markdown。"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
|
@ -73,41 +21,13 @@ body:
|
|||
id: proposal
|
||||
attributes:
|
||||
label: 期望方案
|
||||
description: 描述你希望 DBX 如何支持这个功能。
|
||||
placeholder: "例如:在查询结果右上角增加导出 Markdown 按钮,可选择是否包含表头。"
|
||||
description: 希望怎么支持?
|
||||
placeholder: "例如:在查询结果右上角增加导出 Markdown 按钮。"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: workflow
|
||||
id: extra
|
||||
attributes:
|
||||
label: 期望工作流
|
||||
description: 如果能描述用户操作路径,会更容易落地成产品设计。
|
||||
placeholder: |
|
||||
1. 打开连接
|
||||
2. 执行查询
|
||||
3. 点击 ...
|
||||
4. 得到 ...
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: 你试过的替代方案
|
||||
description: 例如目前如何绕过、是否使用其他工具完成、有什么缺点。
|
||||
|
||||
- type: textarea
|
||||
id: references
|
||||
attributes:
|
||||
label: 参考截图 / 产品 / 文档
|
||||
description: 可以拖入截图,或贴出类似功能的链接。
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: 需求紧急程度
|
||||
options:
|
||||
- 只是想法,不急
|
||||
- 会明显提升日常使用体验
|
||||
- 当前工作流被阻塞
|
||||
validations:
|
||||
required: true
|
||||
label: 补充信息
|
||||
description: 参考截图、相关数据库类型、替代方案等。
|
||||
|
|
|
|||
|
|
@ -1,69 +1,23 @@
|
|||
name: 问题咨询 / 讨论
|
||||
description: 使用疑问、配置问题、设计讨论或不确定是否为 bug 的反馈。
|
||||
name: 问题咨询
|
||||
description: 使用疑问、配置问题或不确定是否为 bug 的反馈。
|
||||
title: "[Question] "
|
||||
labels: ["question"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
如果你不确定是 bug 还是使用问题,可以先从这里提交。请尽量说明你的目标、当前做法和卡住的位置。
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: 提交前确认
|
||||
options:
|
||||
- label: 我已查看 README 和现有 issues。
|
||||
required: true
|
||||
- label: 我不会在 issue 中提交真实密码、Token、私钥或生产数据。
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: topic
|
||||
attributes:
|
||||
label: 主题
|
||||
options:
|
||||
- 安装 / 启动
|
||||
- 数据库连接
|
||||
- SSH 隧道
|
||||
- 查询 / SQL
|
||||
- 数据浏览 / 编辑
|
||||
- Redis
|
||||
- MongoDB
|
||||
- 导入导出
|
||||
- AI 助手
|
||||
- 开发 / 构建
|
||||
- 其他
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: goal
|
||||
attributes:
|
||||
label: 你想完成什么?
|
||||
placeholder: "例如:我想通过 SSH 隧道连接内网 PostgreSQL,但不确定应该怎么填写配置。"
|
||||
label: 描述
|
||||
description: 你想完成什么?已经尝试了什么?
|
||||
placeholder: "例如:我想通过 SSH 隧道连接内网 PostgreSQL,已确认本机 psql 可以连接,但 DBX 中测试连接提示..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: tried
|
||||
attributes:
|
||||
label: 你已经尝试了什么?
|
||||
placeholder: "例如:已确认本机 psql 可以连接;DBX 中测试连接提示 ..."
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: 相关环境
|
||||
description: 如果和数据库或系统有关,请提供数据库类型、版本、操作系统、DBX 版本等。
|
||||
label: 环境信息
|
||||
description: 数据库类型和版本、操作系统、DBX 版本等。
|
||||
placeholder: |
|
||||
DBX:
|
||||
DBX 版本:
|
||||
操作系统:
|
||||
数据库类型和版本:
|
||||
连接方式:
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: 截图 / 日志
|
||||
description: 可以拖入截图,或粘贴脱敏后的日志。
|
||||
数据库:
|
||||
|
|
|
|||
Loading…
Reference in New Issue