diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 125456936f..49487a2874 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,58 +7,51 @@ body: attributes: value: | 感谢反馈。涉及敏感信息请脱敏。请尽量提供数据库类型、版本、复现步骤、截图和错误日志。 + Thanks for reporting this. Redact sensitive information and include the database type/version, reproduction steps, screenshots, and logs when possible. DBX 版本、运行环境、操作系统和系统架构可在应用内通过“设置 → 关于我们 → 复制支持信息”一键复制。 - + You can copy the DBX version, runtime, operating system, and architecture in the app via “Settings → About → Copy support information”. - type: input id: database attributes: - label: 数据库类型和版本 - description: 例如 PostgreSQL 16、MySQL 8.0、Redis 7.2。 - placeholder: "例如：PostgreSQL 16.2" - validations: - required: true - + label: 数据库类型和版本 / Database type and version + description: 例如 PostgreSQL 16、MySQL 8.0、Redis 7.2。 / For example, PostgreSQL 16, MySQL 8.0, or Redis 7.2. + placeholder: "例如：PostgreSQL 16.2 / Example: PostgreSQL 16.2" + validations: {required: true} - type: textarea id: description attributes: - label: 问题描述 - description: 请按下面的清单逐项填写，截图和错误日志尤其重要。 + label: 问题描述 / Problem description + description: 请按下面的清单逐项填写。 / Complete each item below. placeholder: | - 1. 复现步骤：新建连接 → 填写信息 → 点击保存 - 2. 期望结果：能正常展开 schema - 3. 实际结果：一直 loading，无错误提示 - 4. 最好附上截图和错误日志（设置 → 外观 → 启用"启用调试日志" → 复现问题 → 点击"下载日志"，将内容粘贴到这里） - validations: - required: true - + 1. 复现步骤 / Steps: 新建连接 → 填写信息 → 点击保存 / Create connection → enter details → click Save + 2. 期望结果 / Expected: 能正常展开 schema / Schema expands normally + 3. 实际结果 / Actual: 一直 loading，无错误提示 / Loading never finishes + 4. 附上截图和错误日志 / Attach screenshots and logs when possible + validations: {required: true} - type: textarea id: support-info attributes: - label: 支持信息 - description: 打开 DBX 的“设置 → 关于我们”，点击“复制支持信息”，然后粘贴到这里。如无法打开应用，请说明原因。 + label: 支持信息 / Support information + description: 粘贴“复制支持信息”的结果；如无法打开应用，请说明原因。 / Paste the copied support information; explain if the app cannot open. placeholder: | - DBX 版本：v0.5.52 - 运行环境：桌面端 - 操作系统：macOS 26.4 - 系统架构：aarch64 - validations: - required: true - + DBX 版本 / Version: v0.5.52 + 运行环境 / Runtime: Desktop + 操作系统 / OS: macOS 26.4 + 系统架构 / Architecture: aarch64 + validations: {required: true} - type: dropdown id: priority attributes: - label: 优先级（是否紧急） - description: 紧急 = 希望下个版本优先修。维护者可根据实际情况调整。 + label: 优先级（是否紧急） / Priority (urgency) + description: 紧急 = 希望下个版本优先修；维护者可调整。 / Urgent means you hope for the next release; maintainers may adjust it. options: - - "🔴 P0 紧急 · 下个版本必须修" - - "🟠 P1 重要 · 尽快处理" - - "🟡 P2 普通 · 按排期处理" - - "🟢 P3 低优 · 有空再修" - validations: - required: true - + - "🔴 P0 紧急 · 下个版本必须修 / Urgent · Must fix next release" + - "🟠 P1 重要 · 尽快处理 / Important · Fix soon" + - "🟡 P2 普通 · 按排期处理 / Normal · Schedule as appropriate" + - "🟢 P3 低优 · 有空再修 / Low · Fix when possible" + validations: {required: true} - type: textarea id: extra attributes: - label: 补充信息 - description: 截图、SQL 样例、连接方式、特殊环境等。 + label: 补充信息 / Additional information + description: 截图、SQL 样例、连接方式、特殊环境等。 / Screenshots, SQL samples, connection method, or special environments. diff --git a/.github/ISSUE_TEMPLATE/database_compatibility.yml b/.github/ISSUE_TEMPLATE/database_compatibility.yml index 7a4f60d71f..8921ba9fac 100644 --- a/.github/ISSUE_TEMPLATE/database_compatibility.yml +++ b/.github/ISSUE_TEMPLATE/database_compatibility.yml @@ -7,13 +7,14 @@ body: attributes: value: | 用于收集数据库兼容性细节，例如连接失败、schema 读取不完整、字段类型显示错误等。请脱敏。 - DBX 版本、运行环境、操作系统和系统架构可在应用内通过“设置 → 关于我们 → 复制支持信息”一键复制。 + This form collects database compatibility details such as connection failures, incomplete schema reads, and incorrect field types. Redact sensitive information. + DBX 版本、运行环境、操作系统和系统架构可在应用内通过“设置 → 关于我们 → 复制支持信息 / Support information”一键复制。 - type: input id: database attributes: - label: 数据库类型和版本 - description: 也请注明发行版，如 MariaDB、AWS RDS、TiDB 等。 + label: 数据库类型和版本 / Database type and version + description: 也请注明发行版，如 MariaDB、AWS RDS、TiDB 等。 / Include the distribution, such as MariaDB, AWS RDS, or TiDB. placeholder: "例如：MariaDB 10.11" validations: required: true @@ -21,16 +22,17 @@ body: - type: textarea id: description attributes: - label: 问题描述 - description: 什么操作，出了什么错，期望怎样？ - placeholder: "例如：展开 schema 时报错 'unknown type'，期望能正常显示字段。" + label: 问题描述 / Description / Problem description + description: 什么操作，出了什么错，期望怎样？ / What did you do, what went wrong, and what did you expect? + # What did you do, what went wrong, and what did you expect? + placeholder: "例如：展开 schema 时报错 'unknown type'，期望能正常显示字段。 / Example: expanding a schema reports 'unknown type'; fields should display normally." validations: required: true - type: textarea id: error attributes: - label: 错误信息 + label: 错误信息 / Error message render: shell validations: required: true @@ -38,8 +40,8 @@ body: - type: textarea id: support-info attributes: - label: 支持信息 - description: 打开 DBX 的“设置 → 关于我们”，点击“复制支持信息”，然后粘贴到这里。如无法打开应用，请说明原因。 + label: 支持信息 / Support information + description: 打开 DBX 的“设置 → 关于我们”，点击“复制支持信息”，然后粘贴到这里。如无法打开应用，请说明原因。 / Open DBX Settings → About, copy Support Information, and paste it here. Explain if the app cannot open. placeholder: | DBX 版本：v0.5.52 运行环境：桌面端 @@ -51,5 +53,6 @@ body: - type: textarea id: extra attributes: - label: 补充信息 - description: 表结构、SQL 样例、截图、部署方式（Docker/云/自建）等。 + label: 补充信息 / Additional information + description: 表结构、SQL 样例、截图、部署方式（Docker/云/自建）等。 / Include schema, SQL samples, screenshots, and deployment details (Docker, cloud, or self-hosted). + # Include schema, SQL samples, screenshots, and deployment details (Docker, cloud, or self-hosted). diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d968ee2de6..4d17acead6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -6,64 +6,55 @@ body: - type: markdown attributes: value: | - 好的建议最好说明使用场景、数据库类型和期望效果。请尽量避免只写“支持 X”。 + 好的建议最好说明使用场景、数据库类型和期望效果。请避免只写“支持 X”。 + Describe the use case, database type, and desired outcome; avoid requests that only say “support X”. DBX 版本、运行环境、操作系统和系统架构可在应用内通过“设置 → 关于我们 → 复制支持信息”一键复制。 - + You can copy the DBX version, runtime, operating system, and architecture in the app via “Settings → About → Copy support information”. - type: input id: database attributes: - label: 数据库类型和版本 - description: 如果是通用功能，请填写“通用”。如果只影响特定数据源，请注明数据库类型、版本或发行版。 - placeholder: "例如：PostgreSQL 16.2 / MySQL 8.0 / Redis 7.2 / 通用" - validations: - required: true - + label: 数据库类型和版本 / Database type and version + description: 通用功能请填写“通用”；特定数据源请注明类型和版本。 / Enter “通用” for general features; otherwise specify the data source and version. + placeholder: "例如：PostgreSQL 16.2 / MySQL 8.0 / Redis 7.2 / 通用 · General" + validations: {required: true} - type: textarea id: support-info attributes: - label: 支持信息 - description: 打开 DBX 的“设置 → 关于我们”，点击“复制支持信息”，然后粘贴到这里。如无法打开应用，请说明原因。 + label: 支持信息 / Support information + description: 粘贴应用中的支持信息。 / Paste the support information copied from the app. placeholder: | - DBX 版本：v0.5.52 - 运行环境：桌面端 - 操作系统：macOS 26.4 - 系统架构：aarch64 - validations: - required: true - + DBX 版本 / Version: v0.5.52 + 运行环境 / Runtime: Desktop + 操作系统 / OS: macOS 26.4 + 系统架构 / Architecture: aarch64 + validations: {required: true} - type: textarea id: problem attributes: - label: 当前痛点 - description: 现在做这件事有什么不方便？ - placeholder: "例如：每次查询后都要手动复制结果再转成 Markdown。" - validations: - required: true - + label: 当前痛点 / Current pain point + description: 现在做这件事有什么不方便？ / What is inconvenient about the current workflow? + placeholder: "例如：每次查询后都要手动复制结果再转成 Markdown。 / Example: I must manually copy query results and convert them to Markdown." + validations: {required: true} - type: textarea id: proposal attributes: - label: 期望方案 - description: 希望怎么支持？ - placeholder: "例如：在查询结果右上角增加导出 Markdown 按钮。" - validations: - required: true - + label: 期望方案 / Proposed solution + description: 希望怎么支持？ / How would you like this to work? + placeholder: "例如：在查询结果右上角增加导出 Markdown 按钮。 / Example: Add an Export to Markdown button." + validations: {required: true} - type: dropdown id: priority attributes: - label: 优先级（是否紧急） - description: 紧急 = 希望下个版本优先做。维护者可根据实际情况调整。 + label: 优先级（是否紧急） / Priority (urgency) + description: 紧急 = 希望下个版本优先做；维护者可调整。 / Urgent means you hope for the next release; maintainers may adjust it. options: - - "🔴 P0 紧急 · 下个版本必须做" - - "🟠 P1 重要 · 尽快处理" - - "🟡 P2 普通 · 按排期处理" - - "🟢 P3 低优 · 有空再做" - validations: - required: true - + - "🔴 P0 紧急 · 下个版本必须做 / Urgent · Must do next release" + - "🟠 P1 重要 · 尽快处理 / Important · Do soon" + - "🟡 P2 普通 · 按排期处理 / Normal · Schedule as appropriate" + - "🟢 P3 低优 · 有空再做 / Low · Do when possible" + validations: {required: true} - type: textarea id: extra attributes: - label: 补充信息 - description: 参考截图、替代方案、特殊环境等。 + label: 补充信息 / Additional information + description: 参考截图、替代方案、特殊环境等。 / Screenshots, alternatives, or special environments. diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index c03f4da6a7..9cc03fdcca 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -6,8 +6,9 @@ body: - type: input id: database attributes: - label: 数据库类型和版本 - description: 如果问题与数据库无关，请填写“无关”。否则请注明数据库类型、版本或发行版。 + label: 数据库类型和版本 / Database type and version + description: 如果问题与数据库无关，请填写“无关”。否则请注明数据库类型、版本或发行版。 / Enter “无关” if unrelated to a database; otherwise specify the type, version, or distribution. + # Enter “无关” if unrelated to a database; otherwise specify the type, version, or distribution. placeholder: "例如：PostgreSQL 16.2 / MySQL 8.0 / Redis 7.2 / 无关" validations: required: true @@ -15,8 +16,8 @@ body: - type: textarea id: support-info attributes: - label: 支持信息 - description: 打开 DBX 的“设置 → 关于我们”，点击“复制支持信息”，然后粘贴到这里。如无法打开应用，请说明原因。 + label: 支持信息 / Support information + description: 打开 DBX 的“设置 → 关于我们”，点击“复制支持信息 / Support information”，然后粘贴到这里。如无法打开应用，请说明原因。 placeholder: | DBX 版本：v0.5.52 运行环境：桌面端 @@ -28,8 +29,9 @@ body: - type: textarea id: goal attributes: - label: 描述 - description: 你想完成什么？已经尝试了什么？ + label: 描述 / Description + description: 你想完成什么？已经尝试了什么？ / What are you trying to accomplish, and what have you already tried? + # What are you trying to accomplish, and what have you already tried? placeholder: "例如：我想通过 SSH 隧道连接内网 PostgreSQL，已确认本机 psql 可以连接，但 DBX 中测试连接提示..." validations: required: true @@ -37,8 +39,9 @@ body: - type: textarea id: context attributes: - label: 环境信息 - description: 连接方式、特殊环境、已尝试的排查方式等。 + label: 环境信息 / Environment + description: 连接方式、特殊环境、已尝试的排查方式等。 / Connection method, special environment, and troubleshooting already attempted. + # Connection method, special environment, and troubleshooting already attempted. placeholder: | 连接方式： 补充环境： diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index dc5bb4d3f7..aeb86dd61f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,32 +1,32 @@ -## 变更说明 +## 变更说明 / Change Description - + -## 变更类型 +## 变更类型 / Change Type -- [ ] 新功能 -- [ ] Bug 修复 -- [ ] 性能优化 -- [ ] 代码重构 -- [ ] 文档更新 -- [ ] CI / 构建 +- [ ] 新功能 / New feature +- [ ] Bug 修复 / Bug fix +- [ ] 性能优化 / Performance improvement +- [ ] 代码重构 / Code refactoring +- [ ] 文档更新 / Documentation +- [ ] CI / 构建 / CI or build -## 涉及前端 +## 涉及前端 / Frontend Changes - + -- [ ] 本 PR 涉及前端改动，已附截图/录屏（见下方） +- [ ] 本 PR 涉及前端改动，已附截图/录屏（见下方） / This PR includes frontend changes and screenshots or a recording are attached below. - + -## 验证 +## 验证 / Validation - + -- [ ] `make check` 通过 -- [ ] `make cargo-check-fast` 通过 -- [ ] 相关测试通过 +- [ ] `make check` 通过 / `make check` passes +- [ ] `make cargo-check-fast` 通过 / `make cargo-check-fast` passes +- [ ] 相关测试通过 / Relevant tests pass -## 关联 Issue +## 关联 Issue / Related Issue - +