From 6d5b4329db0c443077e9f5ca28b72f72273a2807 Mon Sep 17 00:00:00 2001 From: MatrixSeven Date: Wed, 3 Sep 2025 10:45:04 +0800 Subject: [PATCH] =?UTF-8?q?feat:issue=E6=A8=A1=E6=9D=BF=E6=B7=BB=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yml | 126 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 72 ++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 54 +++++++++ 4 files changed, 263 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..b858364 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,126 @@ +name: 🐛 Bug 报告 +description: 报告一个错误或问题 +title: "[Bug] " +labels: ["bug", "需要调查"] +body: + - type: markdown + attributes: + value: | + 感谢您花时间填写错误报告！请详细描述遇到的问题，这将帮助我们更快地定位和解决问题。 + + - type: textarea + id: problem-description + attributes: + label: 问题描述 + description: 请详细描述您遇到的问题 + placeholder: | + 例如：在文件传输过程中，当传输大文件时连接会意外断开... + validations: + required: true + + - type: dropdown + id: deployment-environment + attributes: + label: 部署环境 + description: 您使用的是什么部署方式？ + options: + - 二进制部署（下载发布的可执行文件） + - 自行构建（从源码编译） + - Docker 部署 + - 官方演示站 + - 其他（请在详细信息中说明） + validations: + required: true + + - type: textarea + id: environment-details + attributes: + label: 环境详细信息 + description: 请提供环境相关信息 + placeholder: | + - 操作系统：Linux Ubuntu 20.04 / Windows 10 / macOS 12.x + - 浏览器：Chrome 120.x / Firefox 121.x / Safari 17.x + - 网络环境：局域网 / 公网 / NAT环境 + - 设备类型：PC / 移动设备 + - 其他相关信息... + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: 复现步骤 + description: 请描述如何复现这个问题 + placeholder: | + 1. 打开应用 + 2. 点击 '文件传输' + 3. 选择一个大文件 (>100MB) + 4. 点击发送 + 5. 观察到连接断开... + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: 预期行为 + description: 您期望发生什么？ + placeholder: 文件应该能够正常传输完成 + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: 实际行为 + description: 实际发生了什么？ + placeholder: 传输进度到50%时连接突然断开，显示"连接失败"错误 + validations: + required: true + + - type: textarea + id: logs + attributes: + label: 相关日志 + description: | + 请提供相关的错误日志、控制台输出或服务器日志 + 提示：您可以在浏览器开发者工具的控制台中查看客户端日志 + render: text + placeholder: | + [2024-01-15 10:30:45] [ERROR] WebRTC连接失败: ICE连接超时 + [2024-01-15 10:30:45] [INFO] 尝试重新连接... + + 或者粘贴浏览器控制台的错误信息... + + - type: textarea + id: screenshots + attributes: + label: 截图或录屏 + description: | + 如果适用，请添加截图或录屏来帮助解释您的问题 + 您可以直接拖拽图片到这个文本框中 + placeholder: 拖拽图片文件到这里，或者粘贴图片链接 + + - type: textarea + id: additional-context + attributes: + label: 其他信息 + description: 任何其他可能有助于解决问题的信息 + placeholder: | + - 问题发生的频率：每次 / 偶尔 / 特定条件下 + - 是否在多个设备上都出现 + - 最近是否有环境变化 + - 其他可能相关的信息... + + - type: checkboxes + id: terms + attributes: + label: 确认事项 + description: 在提交前，请确认以下事项 + options: + - label: 我已经搜索了现有的 Issues，确认这不是重复问题 + required: true + - label: 我已经提供了足够的信息来复现和诊断问题 + required: true + - label: 我理解维护者可能需要更多信息来解决问题 + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9bbaf0b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: 📚 项目文档 + url: https://github.com/MatrixSeven/file-transfer-go/blob/main/README.md + about: 查看项目使用文档和部署指南 + - name: 💬 讨论区 + url: https://github.com/MatrixSeven/file-transfer-go/discussions + about: 参与社区讨论，分享使用经验和想法 + - name: 🌐 官方演示 + url: https://transfer.52python.cn/ + about: 访问官方演示站点体验功能（如果可用） diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..0a66521 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,72 @@ +name: ✨ 功能请求 +description: 建议一个新功能或改进 +title: "[Feature] " +labels: ["enhancement", "功能请求"] +body: + - type: markdown + attributes: + value: | + 感谢您提出功能建议！您的想法对改进项目非常重要。请详细描述您的建议。 + + - type: textarea + id: feature-description + attributes: + label: 建议功能 + description: 请清楚简洁地描述您希望实现的功能 + placeholder: | + 例如：希望添加文件加密传输功能，在传输过程中对文件进行端到端加密... + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: 需求原因 + description: 请解释为什么需要这个功能，它解决了什么问题？ + placeholder: | + 例如： + - 当前在传输敏感文件时缺乏安全保障 + - 在公网环境下传输文件可能被第三方截获 + - 企业用户需要确保数据传输的安全性 + validations: + required: true + + - type: textarea + id: use-cases + attributes: + label: 使用场景 + description: 请描述这个功能的具体使用场景和出发点 + placeholder: | + 例如： + - 医疗机构传输患者档案时需要加密保护 + - 企业内部传输财务报表等敏感文档 + - 个人用户传输私人照片和视频时希望保护隐私 + - 在不受信任的网络环境下进行文件传输 + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: 优先级 + description: 您认为这个功能的优先级如何？ + options: + - 低（Nice to have） + - 中（重要但不紧急） + - 高（对用户体验很重要） + - 关键（阻碍正常使用） + validations: + required: true + + + - type: textarea + id: additional-context + attributes: + label: 其他信息 + description: 任何其他可能有助于理解和实现这个功能的信息 + placeholder: | + - 类似功能的参考应用或网站 + - 相关技术文档或标准 + - 社区讨论链接 + - 其他补充说明 + diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..e1ee4a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,54 @@ +name: 💬 问题咨询 +description: 使用问题、配置疑问或一般性讨论 +title: "[Question] " +labels: ["question", "需要回复"] +body: + - type: markdown + attributes: + value: | + 如果您有使用问题、配置疑问或想要讨论项目相关话题，请使用这个模板。 + + - type: dropdown + id: question-type + attributes: + label: 问题类型 + description: 请选择您的问题类型 + options: + - 使用问题（如何使用某个功能） + - 配置问题（部署和设置相关） + - 技术咨询（技术实现相关） + - 功能理解（不确定某个功能如何工作） + - 其他 + validations: + required: true + + - type: textarea + id: question + attributes: + label: 具体问题 + description: 请详细描述您的问题 + placeholder: | + 例如：我想在内网环境下部署这个应用，但是不知道如何配置STUN服务器... + validations: + required: true + + - type: textarea + id: environment + attributes: + label: 环境信息 + description: 如果相关，请提供环境信息 + placeholder: | + - 操作系统： + - 部署方式： + - 网络环境： + - 浏览器版本： + + - type: checkboxes + id: checklist + attributes: + label: 确认事项 + options: + - label: 我已经查看了项目文档和README + required: true + - label: 我已经搜索了现有的Issues + required: true