diff --git a/.github/ISSUE_TEMPLATE/0_bug_report.yml b/.github/ISSUE_TEMPLATE/0_bug_report.yml index 3b0515d5..ac3712af 100644 --- a/.github/ISSUE_TEMPLATE/0_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/0_bug_report.yml @@ -18,7 +18,7 @@ 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) and [Closed Issues]( https://github.com/CherryHQ/cherry-studio/issues?q=is%3Aissue%20state%3Aclosed%20), no similar issue was found. + - 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 @@ -48,8 +48,8 @@ body: id: description attributes: label: Bug Description - description: Please be as detailed as possible when describing the problem - placeholder: Tell us what happened... + description: Please be as detailed as possible when describing the problem. Please provide screenshots or screen recordings whenever possible to help us better understand the issue. + placeholder: Tell us what happened... (Remember to attach screenshots/recordings if applicable) validations: required: true @@ -57,12 +57,14 @@ body: id: reproduction attributes: label: Steps To Reproduce - description: Provide detailed steps to reproduce the issue so that our developers can reproduce the issue accurately + description: Provide detailed steps to reproduce the issue so that our developers can reproduce the issue accurately. Please include screenshots or screen recordings for each step when possible. placeholder: | 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error + + Remember to attach screenshots/recordings for each step when possible! validations: required: true diff --git a/.github/ISSUE_TEMPLATE/1_feature_request.yml b/.github/ISSUE_TEMPLATE/1_feature_request.yml index 831b5f10..19376055 100644 --- a/.github/ISSUE_TEMPLATE/1_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/1_feature_request.yml @@ -18,7 +18,7 @@ body: options: - label: I understand that issues are for reporting problems and requesting features, not for off-topic comments, and I will provide as much detail as possible to help resolve the issue. required: true - - label: I have checked the pinned issues and searched through the existing [open issues](https://github.com/CherryHQ/cherry-studio/issues) and [closed issues](https://github.com/CherryHQ/cherry-studio/issues?q=is%3Aissue%20state%3Aclosed) and did not find a similar suggestion. + - label: I have checked the pinned issues and searched through the 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) and did not find a similar suggestion. required: true - label: I have provided a short and descriptive title so that developers can quickly understand the issue when browsing the issue list, rather than vague titles like "A suggestion" or "Stuck." required: true @@ -50,8 +50,8 @@ body: id: problem attributes: label: Is your feature request related to an existing issue? - description: Please briefly describe the problem you are experiencing. - placeholder: I often feel frustrated because... + description: Please briefly describe the problem you are experiencing. If possible, include screenshots or recordings to help illustrate the current situation or pain points. + placeholder: I often feel frustrated because... (Remember to attach screenshots/recordings if applicable) validations: required: true @@ -59,7 +59,7 @@ body: id: solution attributes: label: Desired Solution - description: Please briefly describe what you would like to happen. + description: Please briefly describe what you would like to happen. You can include mockups, screenshots, or screen recordings to better illustrate your proposed solution. validations: required: true @@ -67,10 +67,10 @@ body: id: alternatives attributes: label: Alternative Solutions - description: Please briefly describe any alternative solutions or features you have considered. + description: Please briefly describe any alternative solutions or features you have considered. Feel free to include screenshots or mockups of alternative approaches. - type: textarea id: additional attributes: label: Additional Information - description: Add any other context or screenshots related to your feature request. + description: Add any other context, screenshots, mockups or recordings that can help us better understand your feature request. diff --git a/.github/ISSUE_TEMPLATE/2_question.yml b/.github/ISSUE_TEMPLATE/2_question.yml index d191daf7..f980e691 100644 --- a/.github/ISSUE_TEMPLATE/2_question.yml +++ b/.github/ISSUE_TEMPLATE/2_question.yml @@ -17,6 +17,8 @@ body: options: - label: I understand that issues are meant for feedback and problem-solving, not for venting, and I will provide as much detail as possible to help resolve the issue. required: true + - label: I have checked the pinned issues and searched through the 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) and did not find a similar suggestion. + required: true - label: I confirm that I am here to ask questions and discuss issues, not to report bugs or request features. required: true @@ -45,8 +47,8 @@ body: id: question attributes: label: Your Question - description: Please describe your issue in detail. - placeholder: Please explain your issue as clearly as possible... + description: Please describe your issue in detail. Include screenshots or screen recordings whenever possible to help us better understand your question. + placeholder: Please explain your issue as clearly as possible...(Remember to attach screenshots/recordings if applicable) validations: required: true @@ -54,14 +56,14 @@ body: id: context attributes: label: Context - description: Please provide some background information to help us better understand your question - placeholder: "For example: use case, solutions you've tried, etc." + description: Please provide some background information to help us better understand your question. Screenshots or recordings of your current setup or situation can be very helpful. + placeholder: "For example: use case, solutions you've tried, etc. Don't forget to include relevant screenshots/recordings!" - type: textarea id: additional attributes: label: Additional Information - description: Any other relevant information, screenshots, or code examples + description: Any other relevant information, screenshots, recordings, or code examples that can help us better assist you render: shell - type: dropdown