diff --git a/.github/ISSUE_TEMPLATE/cn_bug_report_zh.yml b/.github/ISSUE_TEMPLATE/cn_bug_report_zh.yml index b01fccaa7..763bc3c2b 100644 --- a/.github/ISSUE_TEMPLATE/cn_bug_report_zh.yml +++ b/.github/ISSUE_TEMPLATE/cn_bug_report_zh.yml @@ -1,9 +1,7 @@ name: 反馈问题 description: 反馈问题 -title: "🐞 反馈问题：请填写标题" +title: "🐞 反馈问题：" labels: ["bug"] -assignees: - - body: - type: checkboxes @@ -15,14 +13,14 @@ body: required: true - label: 在 [issues](https://github.com/tisfeng/Easydict/issues) 页面搜索过问题（包括已关闭的 issue），但未能找到解决方法 required: true - - label: Easydict 已升级到最新版本 + - label: Easydict 已升级到 [最新版本](https://github.com/tisfeng/Easydict/releases) required: true - type: textarea id: description attributes: label: 问题描述 - description: 请尽量清晰、详细地描述问题。如果涉及 UI，请提供截图，若问题比较复杂，最好能提供录屏，方便开发者排查。如果是应用崩溃问题，请提供崩溃日志，菜单图标 -> 帮助 -> 导出日志。 + description: 请详细描述你遇到的问题。 placeholder: 问题描述 validations: required: true @@ -31,8 +29,21 @@ body: id: reproduce attributes: label: 重现步骤 - description: 请描述如何重现该问题。如果该问题是偶发性的，或者需要特定的操作步骤才能重现，请尽量详细地描述。\n如果是偶发性问题，请尝试重启应用，卸载后重新安装应用，或者重启设备，看是否能解决问题。 - placeholder: + description: | + 请描述如何重现该问题。如果该问题是偶发性的，或者需要特定的操作步骤才能重现，请一定要详细提供重现步骤，否则开发者无法定位问题。 + （如果遇到一些很奇怪的问题，可以先尝试重启应用，重启电脑，或卸载重装应用，看能否解决问题 🤔） + placeholder: 重现步骤 + validations: + required: true + + - type: textarea + id: screenshot + attributes: + label: 截图 + description: | + 请提供问题截图。若截图不便于描述问题，请提供录屏，方便开发者排查。 + 如果是应用崩溃问题，请务必提供崩溃日志，菜单图标 -> 帮助 -> 导出日志。（日志目录：`~/Library/Caches/com.izual.Easydict/MMLogs`） + placeholder: 请提供截图 validations: required: true @@ -41,7 +52,7 @@ body: attributes: label: 期望结果 description: 请描述您期望的结果。 - placeholder: + placeholder: 期望结果 validations: required: true @@ -50,13 +61,13 @@ body: attributes: label: 解决方案（可选） description: 对于该问题，您有什么预想的解决方案，或者建议？ - placeholder: + placeholder: 解决方案 - type: input id: device attributes: - label: 设备信息 && 操作系统版本 - description: 如果遇到比较奇怪的问题，请提供设备信息和操作系统版本，方便开发者排查 + label: 设备型号 && 系统版本 + description: 如果遇到比较奇怪的问题，请提供设备型号和操作系统版本，方便开发者排查。 placeholder: Apple M1 Pro, macOS 14.0 - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/en_bug_report.yml b/.github/ISSUE_TEMPLATE/en_bug_report.yml index bc30c73d1..a05940e3c 100644 --- a/.github/ISSUE_TEMPLATE/en_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/en_bug_report.yml @@ -1,9 +1,7 @@ name: Bug report description: Report an issue -title: "🐞 Bug Report: Please fill in the title" +title: "🐞 Bug Report: " labels: ["bug"] -assignees: - - body: - type: checkboxes @@ -15,14 +13,14 @@ body: required: true - label: I have searched through the [issues](https://github.com/tisfeng/Easydict/issues) page but couldn't find a solution.(Including issue that has been closed) required: true - - label: Easydict has been upgraded to the latest version. + - label: Easydict has been upgraded to the [latest version](https://github.com/tisfeng/Easydict/releases) required: true - type: textarea id: description attributes: label: Problem description - description: Please describe the problem as clearly and detailed as possible. If it involves UI, please provide screenshots. If it's a complex problem, it would be best to provide a screencast to help developers troubleshoot. If it is an application crash issue, please provide the crash log, menu icon -> Help -> Export Log. + description: Please describe the problem as clearly and detailed as possible. placeholder: Problem description validations: required: true @@ -31,8 +29,21 @@ body: id: reproduce attributes: label: Reproduction steps - description: Please describe how to reproduce the problem. If the problem is episodic or requires specific action steps to reproduce, please describe it in as much detail as possible. \n If the problem is episodic, try restarting the app, uninstalling and reinstalling the app, or restarting the device to see if that solves the problem. - placeholder: + description: | + Please describe how to reproduce the problem. If the problem is episodic or requires specific action steps to reproduce, please describe it in as much detail as possible, otherwise the developer will not be able to locate the problem. + (If the problem is episodic, try restarting the app, restarting the device, or uninstalling and reinstalling the app to see if that solves the problem 🤔) + placeholder: Reproduction steps + validations: + required: true + + - type: textarea + id: screenshot + attributes: + label: Screenshot + description: | + Please provide a screenshot of the problem. If the screenshot is not convenient to describe the problem, please provide a screen recording for the developer to troubleshoot. + If it is a crash problem, please provide the crash log, menu icon -> Help -> Export log. (Log directory: `~/Library/Caches/com.izual.Easydict/MMLogs`) + placeholder: Please provide a screenshot validations: required: true @@ -41,7 +52,7 @@ body: attributes: label: Expected result description: Please describe the result you expect. - placeholder: + placeholder: Expected result validations: required: true @@ -50,14 +61,14 @@ body: attributes: label: Proposed solution (optional) description: Do you have any proposed solutions or suggestions for this issue? - placeholder: + placeholder: Proposed solution - type: input id: device attributes: - label: Device information and OS version - description: If you encounter an unusual problem, you can provide device information and OS versions to help developers troubleshoot. - placeholder: Apple M1 Pro, macOS 11.2.3 + label: Device type and OS version + description: If you encounter an unusual problem, you can provide device type and OS versions to help developers troubleshoot. + placeholder: Apple M1 Pro, macOS 14.0 - type: checkboxes id: PR