From 21cb9d52aa653f10173f36cf97325e0bd744ad3f Mon Sep 17 00:00:00 2001 From: kuekhaoyang Date: Sat, 22 Nov 2025 11:14:30 +0800 Subject: [PATCH] docs: Add GitHub issue templates for bug reports and feature requests. --- .github/ISSUE_TEMPLATE/bug_report.yml | 51 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 45 +++++++++++++++++++ 3 files changed, 104 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..5199918 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,51 @@ +name: 🐛 错误报告 (Bug Report) +description: 创建一个报告以帮助我们改进 KVideo +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + 感谢您花时间填写此错误报告! + - type: checkboxes + id: duplicates + attributes: + label: 重复检查 + description: 请确保您已搜索过现有的 Issue,以避免重复报告。 + options: + - label: 我已搜索过现有的 Issue,没有发现类似的问题。 + required: true + - type: textarea + id: description + attributes: + label: 问题描述 + description: 请清晰简洁地描述发生了什么问题。 + placeholder: 比如:点击播放按钮时,播放器没有反应... + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: 复现步骤 + description: 请提供复现该问题的步骤。 + placeholder: | + 1. 打开首页 + 2. 搜索 "Matrix" + 3. 点击第一个结果 + 4. ... + validations: + required: true + - type: input + id: environment + attributes: + label: 环境信息 + description: 请提供您的浏览器版本、操作系统等信息。 + placeholder: Chrome 120, macOS 14.2 + validations: + required: true + - type: textarea + id: logs + attributes: + label: 相关日志 + description: 如果有控制台报错或服务器日志,请粘贴在这里。 + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9443ca8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 提问 / Questions + url: https://github.com/KuekHaoYang/KVideo/discussions/new?category=q-a + about: 如果你有关于项目的问题,请在这里提问。 + - name: 安全漏洞 / Security Vulnerability + url: https://github.com/KuekHaoYang/KVideo/security/advisories/new + about: 报告安全漏洞。 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..b9cb616 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,45 @@ +name: 🚀 功能请求 (Feature Request) +description: 建议一个新功能或改进 +title: "[Feat]: " +labels: ["enhancement", "triage"] +body: + - type: markdown + attributes: + value: | + 感谢您建议新功能! + - type: checkboxes + id: duplicates + attributes: + label: 重复检查 + description: 请确保您已搜索过现有的 Issue,以避免重复建议。 + options: + - label: 我已搜索过现有的 Issue,没有发现类似的建议。 + required: true + - type: textarea + id: problem + attributes: + label: 问题描述 + description: 这个功能是为了解决什么问题? + placeholder: 比如:我总是很难找到我上次看到的视频... + validations: + required: true + - type: textarea + id: solution + attributes: + label: 建议的解决方案 + description: 您希望如何解决这个问题? + placeholder: 比如:添加一个"观看历史"的侧边栏... + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: 替代方案 + description: 您是否考虑过其他替代方案? + validations: + required: false + - type: textarea + id: context + attributes: + label: 其他上下文 + description: 任何其他有助于理解该功能的截图或上下文。