From 83027c383f26f772842771a6d670642fd36c269a Mon Sep 17 00:00:00 2001 From: "Begonia, HE" <163421589+BegoniaHe@users.noreply.github.com> Date: Fri, 16 Jan 2026 04:01:19 +0100 Subject: chore: add GitHub issue and PR templates with automation workflows - Add bilingual issue templates (English & Chinese) - Bug report template with prerequisite checkboxes - Feature request template - Question template - Reverse checkbox detection ("I have not read carefully") - Add bilingual PR templates (English & Chinese) - Comprehensive checklist for code quality and testing - Test environment documentation section - Breaking changes section - Add GitHub Actions workflows - Auto-labeling based on issue content - Auto-close issues with unchecked prerequisites - Stale issue and PR management (90/60 days) - Add template configuration - External links for discussions and wiki - Template chooser interface --- .github/ISSUE_TEMPLATE/bug_report.yml | 214 ++++++++++++++++++++++++++++++++++ 1 file changed, 214 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml (limited to '.github/ISSUE_TEMPLATE/bug_report.yml') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..8bc5903 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,214 @@ +name: Bug Report +description: Report a bug or issue with DropOut Minecraft Launcher +title: "[Bug]: " +labels: ["bug", "needs-triage"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue. + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm you have completed the following before submitting. Issues that check "I have not read carefully" or fail to meet required items may be closed immediately. + options: + - label: I understand that Issues are for reporting and solving problems, not for comments or complaints. I will provide as much information as possible to help resolve the issue. + required: false + - label: I have not read carefully and just clicked through everything, believing this won't affect issue handling. + required: false + - label: I have filled in a short and clear title so that developers can quickly identify the issue when browsing the Issue list, rather than "a suggestion" or "stuck" etc. + required: false + - label: I have searched existing issues to ensure this is not a duplicate + required: false + - label: I am using the latest version of DropOut + required: false + - label: I have read the README and documentation + required: false + + - type: input + id: version + attributes: + label: DropOut Version + description: What version of DropOut are you using? + placeholder: "e.g., 0.1.23" + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System + description: Which operating system are you using? + options: + - Windows 11 + - Windows 10 + - Windows 8,8.1 + - Windows 7 + - macOS (Apple Silicon) + - macOS (Intel) + - Linux (Debian/Ubuntu) + - Linux (Arch) + - Linux (Fedora/RHEL) + - Other Linux + validations: + required: true + + - type: input + id: os-version + attributes: + label: OS Version + description: Specific version of your operating system + placeholder: "e.g., Windows 11 23H2, macOS 14.2, Ubuntu 22.04" + validations: + required: true + + - type: dropdown + id: minecraft-version + attributes: + label: Minecraft Version + description: Which Minecraft version are you trying to launch? + options: + - Latest Release + - Latest Snapshot + - "1.21.x" + - "1.20.x" + - "1.19.x" + - "1.18.x" + - "1.17.x" + - "1.16.x" + - "1.12.x" + - Other (specify in description) + validations: + required: true + + - type: dropdown + id: mod-loader + attributes: + label: Mod Loader + description: Are you using a mod loader? + options: + - None (Vanilla) + - Fabric + - Forge + - Not applicable + validations: + required: true + + - type: input + id: java-version + attributes: + label: Java Version + description: Which Java version are you using? + placeholder: "e.g., Java 21.0.1, Java 17.0.9, Java 8u381" + validations: + required: true + + - type: dropdown + id: java-source + attributes: + label: Java Source + description: Where did you get Java from? + options: + - Auto-detected by DropOut + - Downloaded via DropOut (Adoptium) + - Manually installed (Oracle) + - Manually installed (Sdkman) + - Manually installed (Homebrew) + - Manually installed (Chocolatey) + - Manually installed (Other) + - Unknown + validations: + required: false + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is + placeholder: Describe the issue you're experiencing... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: Describe what you expected to happen... + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + placeholder: Describe what actually happened... + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs and Error Messages + description: | + **📝 TODO: Add instructions for users on how to find and generate log files** + + Examples: + - For Windows: Logs are typically located in `%APPDATA%/DropOut/logs/` + - For macOS: Logs are in `~/Library/Application Support/DropOut/logs/` + - For Linux: Logs are in `~/.config/DropOut/logs/` + + Please paste any relevant logs or error messages here. + This will be automatically formatted as code. + **Please ensure DropOut is closed before uploading files.** + render: shell + placeholder: | + Paste logs here... + validations: + required: false + + - type: textarea + id: screenshots + attributes: + label: Screenshots or Screen Recordings + description: | + If applicable, add screenshots or screen recordings to help explain your problem. + + **⚠️ Important Screenshot Requirements:** + - **Use native screenshot tools** (Windows: Win+Shift+S, macOS: Cmd+Shift+4, Linux: gnome-screenshot/spectacle) + - **DO NOT use QQ/WeChat/Discord screenshot tools** as they may alter resolution and aspect ratio + - **Provide unobstructed original images** - avoid window borders or overlays + - For game-related issues, capture the actual game window + - Keep the original resolution and DPI + + You can compress large files before uploading. + placeholder: Drag and drop images here or paste image URLs + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here + placeholder: Any additional information that might be helpful... + validations: + required: false -- cgit v1.2.3-70-g09d2 From 390ad02a7d24d0ebb902d0af8722106606638efe Mon Sep 17 00:00:00 2001 From: "Begonia, HE" <163421589+BegoniaHe@users.noreply.github.com> Date: Fri, 16 Jan 2026 04:13:12 +0100 Subject: docs: update log file locations in bug report templates Update log file paths to reflect actual application structure: - macOS: /Users/begonia/Library/Application Support/com.dropout.launcher/logs - Linux: /Users/begonia/.local/share/com.dropout.launcher - Remove Windows placeholder as not yet defined --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 ++++----- .github/ISSUE_TEMPLATE/cn-bug-report.yml | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) (limited to '.github/ISSUE_TEMPLATE/bug_report.yml') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8bc5903..732a640 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -169,12 +169,11 @@ body: attributes: label: Logs and Error Messages description: | - **📝 TODO: Add instructions for users on how to find and generate log files** + Please provide relevant logs or error messages to help diagnose the issue. - Examples: - - For Windows: Logs are typically located in `%APPDATA%/DropOut/logs/` - - For macOS: Logs are in `~/Library/Application Support/DropOut/logs/` - - For Linux: Logs are in `~/.config/DropOut/logs/` + **Log file locations:** + - **macOS**: `$HOME/Library/Application Support/com.dropout.launcher/logs` + - **Linux**: `$HOME/.local/share/com.dropout.launcher` Please paste any relevant logs or error messages here. This will be automatically formatted as code. diff --git a/.github/ISSUE_TEMPLATE/cn-bug-report.yml b/.github/ISSUE_TEMPLATE/cn-bug-report.yml index 1fbe3bc..cd55735 100644 --- a/.github/ISSUE_TEMPLATE/cn-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/cn-bug-report.yml @@ -169,12 +169,11 @@ body: attributes: label: 日志和错误信息 description: | - **📝 TODO: 在此添加用户如何查找和生成日志文件的说明** + 请提供相关的日志或错误信息以帮助诊断问题。 - 示例位置： - - Windows: 日志通常位于 `%APPDATA%/DropOut/logs/` - - macOS: 日志位于 `~/Library/Application Support/DropOut/logs/` - - Linux: 日志位于 `~/.config/DropOut/logs/` + **日志文件位置：** + - **macOS**: `$HOME/Library/Application Support/com.dropout.launcher/logs` + - **Linux**: `$HOME/.local/share/com.dropout.launcher` 请在此粘贴相关的日志或错误信息。 内容将自动格式化为代码。 -- cgit v1.2.3-70-g09d2 From 11621cd4b4c9ed3bfdc12c2d3658d89dedcc8d8e Mon Sep 17 00:00:00 2001 From: "Begonia, HE" <163421589+BegoniaHe@users.noreply.github.com> Date: Fri, 16 Jan 2026 04:23:02 +0100 Subject: refactor: improve bug report templates based on PR review - Remove time-sensitive version options (Latest Release/Snapshot) - Simplify Java source option (remove Adoptium annotation) - Update log upload instructions to use launcher terminal - Format screenshot requirements for better readability - Update documentation link to dropout.hydroroll.team Co-authored-by: HsiangNianian --- .github/ISSUE_TEMPLATE/bug_report.yml | 28 +++++++++++++--------------- .github/ISSUE_TEMPLATE/cn-bug-report.yml | 30 ++++++++++++++---------------- .github/ISSUE_TEMPLATE/config.yml | 2 +- 3 files changed, 28 insertions(+), 32 deletions(-) (limited to '.github/ISSUE_TEMPLATE/bug_report.yml') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 732a640..063bbb7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -72,8 +72,6 @@ body: label: Minecraft Version description: Which Minecraft version are you trying to launch? options: - - Latest Release - - Latest Snapshot - "1.21.x" - "1.20.x" - "1.19.x" @@ -114,7 +112,7 @@ body: description: Where did you get Java from? options: - Auto-detected by DropOut - - Downloaded via DropOut (Adoptium) + - Downloaded via DropOut - Manually installed (Oracle) - Manually installed (Sdkman) - Manually installed (Homebrew) @@ -169,18 +167,18 @@ body: attributes: label: Logs and Error Messages description: | - Please provide relevant logs or error messages to help diagnose the issue. + Please upload log files from the DropOut launcher terminal, then paste the log link here. - **Log file locations:** + **How to upload logs:** + 1. Open the terminal in DropOut launcher + 2. Use the built-in log upload feature + 3. Copy the generated log link and paste it below + + If automatic upload is unavailable, you can manually retrieve logs from: - **macOS**: `$HOME/Library/Application Support/com.dropout.launcher/logs` - **Linux**: `$HOME/.local/share/com.dropout.launcher` - - Please paste any relevant logs or error messages here. - This will be automatically formatted as code. - **Please ensure DropOut is closed before uploading files.** - render: shell placeholder: | - Paste logs here... + Paste log link or log content... validations: required: false @@ -191,10 +189,10 @@ body: description: | If applicable, add screenshots or screen recordings to help explain your problem. - **⚠️ Important Screenshot Requirements:** - - **Use native screenshot tools** (Windows: Win+Shift+S, macOS: Cmd+Shift+4, Linux: gnome-screenshot/spectacle) - - **DO NOT use QQ/WeChat/Discord screenshot tools** as they may alter resolution and aspect ratio - - **Provide unobstructed original images** - avoid window borders or overlays + **Screenshot Requirements:** + - Use native screenshot tools (Windows: `Win+Shift+S`, macOS: `Cmd+Shift+4`, Linux: `gnome-screenshot`/`spectacle`) + - DO NOT use QQ/WeChat/Discord screenshot tools as they may alter resolution and aspect ratio + - Provide unobstructed original images, avoid window borders or overlays - For game-related issues, capture the actual game window - Keep the original resolution and DPI diff --git a/.github/ISSUE_TEMPLATE/cn-bug-report.yml b/.github/ISSUE_TEMPLATE/cn-bug-report.yml index cd55735..a128e28 100644 --- a/.github/ISSUE_TEMPLATE/cn-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/cn-bug-report.yml @@ -72,8 +72,6 @@ body: label: Minecraft 版本 description: 您尝试启动的 Minecraft 版本是？ options: - - 最新正式版 - - 最新快照版 - "1.21.x" - "1.20.x" - "1.19.x" @@ -114,7 +112,7 @@ body: description: 您的 Java 来自哪里？ options: - DropOut 自动检测 - - 通过 DropOut 下载 (Adoptium) + - 通过 DropOut 下载 - 手动安装 (Oracle) - 手动安装 (Sdkman) - 手动安装 (Homebrew) @@ -169,18 +167,18 @@ body: attributes: label: 日志和错误信息 description: | - 请提供相关的日志或错误信息以帮助诊断问题。 + 请从 DropOut 启动器终端上传日志文件，然后在此粘贴日志链接。 - **日志文件位置：** + **如何上传日志：** + 1. 在 DropOut 启动器中打开终端 + 2. 使用内置的日志上传功能 + 3. 复制生成的日志链接并粘贴到下方 + + 如果无法使用自动上传，可以手动从以下位置获取日志： - **macOS**: `$HOME/Library/Application Support/com.dropout.launcher/logs` - **Linux**: `$HOME/.local/share/com.dropout.launcher` - - 请在此粘贴相关的日志或错误信息。 - 内容将自动格式化为代码。 - **请确保在上传文件前已关闭 DropOut。** - render: shell placeholder: | - 在此粘贴日志... + 粘贴日志链接或日志内容... validations: required: false @@ -191,11 +189,11 @@ body: description: | 如果适用，请添加截图或录屏以帮助说明您的问题。 - **⚠️ 重要的截图要求：** - - **使用系统自带截图工具**（Windows: Win+Shift+S, macOS: Cmd+Shift+4, Linux: gnome-screenshot/spectacle） - - **不要使用 QQ/微信/Discord 截图工具**，因为它们可能会改变分辨率和纵横比 - - **提供无遮挡的原始图片** - 避免窗口边框或覆盖层 - - 对于游戏相关问题，请捕获实际游戏窗口 + **截图要求：** + - 使用系统自带截图工具（Windows: `Win+Shift+S`, macOS: `Cmd+Shift+4`, Linux: `gnome-screenshot`/`spectacle`） + - 不要使用 QQ/微信/Discord 截图工具，它们可能改变分辨率和纵横比 + - 提供无遮挡的原始图片，避免窗口边框或覆盖层 + - 对于游戏问题，请捕获实际游戏窗口 - 保持原始分辨率和 DPI 可以在上传前压缩大文件。 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c775ed3..b2dbc20 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ blank_issues_enabled: false contact_links: - name: Documentation - url: https://github.com/HsiangNianian/DropOut/blob/main/README.md + url: https://dropout.hydroroll.team about: Read the project documentation and guides - name: Discussions url: https://github.com/HsiangNianian/DropOut/discussions -- cgit v1.2.3-70-g09d2