From 18e99dee67ad13b081035f8554ae712563cf444e Mon Sep 17 00:00:00 2001 From: Asurada <43401755+ousugo@users.noreply.github.com> Date: Tue, 15 Apr 2025 13:29:16 +0800 Subject: [PATCH] chore(issue-template): improve clarity and requirements in bug report checklist (#4847) --- .github/ISSUE_TEMPLATE/#0_bug_report.yml | 12 ++++++++---- .github/ISSUE_TEMPLATE/0_bug_report.yml | 4 +++- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/#0_bug_report.yml b/.github/ISSUE_TEMPLATE/#0_bug_report.yml index 9e33cc57..6991adc4 100644 --- a/.github/ISSUE_TEMPLATE/#0_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/#0_bug_report.yml @@ -18,7 +18,9 @@ body: options: - label: 我理解 Issue 是用于反馈和解决问题的，而非吐槽评论区，将尽可能提供更多信息帮助问题解决。 required: true - - label: 我已经查看了置顶 Issue 并搜索了现有的 [开放Issue](https://github.com/CherryHQ/cherry-studio/issues)和[已关闭Issue](https://github.com/CherryHQ/cherry-studio/issues?q=is%3Aissue%20state%3Aclosed%20)，没有找到类似的问题。 + - label: 我的问题不是 [常见问题](https://github.com/CherryHQ/cherry-studio/issues/3881) 中的内容。 + required: true + - label: 我已经查看了 **置顶 Issue** 并搜索了现有的 [开放Issue](https://github.com/CherryHQ/cherry-studio/issues)和[已关闭Issue](https://github.com/CherryHQ/cherry-studio/issues?q=is%3Aissue%20state%3Aclosed%20)，没有找到类似的问题。 required: true - label: 我填写了简短且清晰明确的标题，以便开发者在翻阅 Issue 列表时能快速确定大致问题。而不是“一个建议”、“卡住了”等。 required: true @@ -48,8 +50,8 @@ body: id: description attributes: label: 错误描述 - description: 描述问题时请尽可能详细 - placeholder: 告诉我们发生了什么... + description: 描述问题时请尽可能详细。请尽可能提供截图或屏幕录制，以帮助我们更好地理解问题。 + placeholder: 告诉我们发生了什么...(记得附上截图/录屏，如果适用) validations: required: true @@ -57,12 +59,14 @@ body: id: reproduction attributes: label: 重现步骤 - description: 提供详细的重现步骤，以便于我们可以准确地重现问题 + description: 提供详细的重现步骤，以便于我们的开发人员可以准确地重现问题。请尽可能为每个步骤提供截图或屏幕录制。 placeholder: | 1. 转到 '...' 2. 点击 '....' 3. 向下滚动到 '....' 4. 看到错误 + + 记得尽可能为每个步骤附上截图/录屏！ validations: required: true diff --git a/.github/ISSUE_TEMPLATE/0_bug_report.yml b/.github/ISSUE_TEMPLATE/0_bug_report.yml index 006279bb..5e58009d 100644 --- a/.github/ISSUE_TEMPLATE/0_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/0_bug_report.yml @@ -18,7 +18,9 @@ body: options: - label: I understand that issues are for feedback and problem solving, not for complaining in the comment section, and will provide as much information as possible to help solve the problem. required: true - - label: I've looked at pinned issues and searched for existing [Open Issues](https://github.com/CherryHQ/cherry-studio/issues), [Closed Issues](https://github.com/CherryHQ/cherry-studio/issues?q=is%3Aissue%20state%3Aclosed), and [Discussions](https://github.com/CherryHQ/cherry-studio/discussions), no similar issue or discussion was found. + - label: My issue is not listed in the [FAQ](https://github.com/CherryHQ/cherry-studio/issues/3881). + required: true + - label: I've looked at **pinned issues** and searched for existing [Open Issues](https://github.com/CherryHQ/cherry-studio/issues), [Closed Issues](https://github.com/CherryHQ/cherry-studio/issues?q=is%3Aissue%20state%3Aclosed), and [Discussions](https://github.com/CherryHQ/cherry-studio/discussions), no similar issue or discussion was found. required: true - label: I've filled in short, clear headings so that developers can quickly identify a rough idea of what to expect when flipping through the list of issues. And not "a suggestion", "stuck", etc. required: true