docs: optimize issues (#1790)

This commit is contained in:
Neal_Tan 2025-02-17 00:12:40 +00:00 committed by GitHub
parent 5be0e0ae72
commit 653e5d82ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 63 additions and 47 deletions

View File

@ -1,4 +1,4 @@
name: 🐛 错误报告 name: 🐛 错误报告 (中文)
description: 创建一个报告以帮助我们改进 description: 创建一个报告以帮助我们改进
title: '[错误]: ' title: '[错误]: '
labels: ['bug'] labels: ['bug']
@ -7,17 +7,20 @@ body:
attributes: attributes:
value: | value: |
感谢您花时间填写此错误报告! 感谢您花时间填写此错误报告!
在提交此问题之前,请确保您已经了解了[常见问题](https://docs.cherry-ai.com/question-contact/questions)和[知识科普](https://docs.cherry-ai.com/question-contact/knowledge)
- type: checkboxes - type: checkboxes
id: checklist id: checklist
attributes: attributes:
label: Issue 检查清单 label: 提交前检查
description: | description: |
在提交 Issue 前请确保您已经完成了以下所有步骤 在提交 Issue 前请确保您已经完成了以下所有步骤
options: options:
- label: 已经查看了置顶 Issue 并搜索了现有的 Issue但没有找到类似的问题 - label: 理解 Issue 是用于反馈和解决问题的,而非吐槽评论区,将尽可能提供更多信息帮助问题解决
required: true required: true
- label: 正确填写了 Issue 标题。 - 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 required: true
- type: dropdown - type: dropdown
@ -45,7 +48,7 @@ body:
id: description id: description
attributes: attributes:
label: 错误描述 label: 错误描述
description: 清晰简洁地描述错误是什么 description: 描述问题时请尽可能详细
placeholder: 告诉我们发生了什么... placeholder: 告诉我们发生了什么...
validations: validations:
required: true required: true
@ -54,7 +57,7 @@ body:
id: reproduction id: reproduction
attributes: attributes:
label: 重现步骤 label: 重现步骤
description: 重现行为的步骤 description: 提供详细的重现步骤,以便于我们可以准确地重现问题
placeholder: | placeholder: |
1. 转到 '...' 1. 转到 '...'
2. 点击 '....' 2. 点击 '....'
@ -82,4 +85,4 @@ body:
id: additional id: additional
attributes: attributes:
label: 附加信息 label: 附加信息
description: 在此添加有关问题的任何其他上下文 description: 任何能让我们对你所遇到的问题有更多了解的东西

View File

@ -1,4 +1,4 @@
name: 💡 功能建议 name: 💡 功能建议 (中文)
description: 为项目提出新的想法 description: 为项目提出新的想法
title: '[功能]: ' title: '[功能]: '
labels: ['enhancement'] labels: ['enhancement']
@ -7,17 +7,22 @@ body:
attributes: attributes:
value: | value: |
感谢您花时间提出新的功能建议! 感谢您花时间提出新的功能建议!
在提交此问题之前,请确保您已经了解了[项目规划](https://docs.cherry-ai.com/cherrystudio/planning)和[功能介绍](https://docs.cherry-ai.com/cherrystudio/preview)
- type: checkboxes - type: checkboxes
id: checklist id: checklist
attributes: attributes:
label: Issue 检查清单 label: 提交前检查
description: | description: |
在提交 Issue 前请确保您已经完成了以下所有步骤 在提交 Issue 前请确保您已经完成了以下所有步骤
options: options:
- label: 已经查看了置顶 Issue 并搜索了现有的 Issue但没有找到类似的问题 - label: 理解 Issue 是用于反馈和解决问题的,而非吐槽评论区,将尽可能提供更多信息帮助问题解决
required: true required: true
- label: 正确填写了 Issue 标题。 - 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
- label: 最新的 Cherry Studio 版本没有实现我所提出的功能。
required: true required: true
- type: dropdown - type: dropdown
@ -44,7 +49,7 @@ body:
- type: textarea - type: textarea
id: problem id: problem
attributes: attributes:
label: 您的功能建议是否与某个问题相关? label: 您的功能建议是否与某个问题/issue相关?
description: 请简明扼要地描述您遇到的问题 description: 请简明扼要地描述您遇到的问题
placeholder: 我总是感到沮丧,因为... placeholder: 我总是感到沮丧,因为...
validations: validations:

View File

@ -1,6 +1,6 @@
name: 提问 name: 讨论 & 提问 (中文)
description: 提出一个问题或寻求帮助 description: 寻求帮助、讨论问题、提出疑问等...
title: '[问题]: ' title: '[讨论]: '
labels: ['question'] labels: ['question']
body: body:
- type: markdown - type: markdown
@ -15,9 +15,9 @@ body:
description: | description: |
在提交 Issue 前请确保您已经完成了以下所有步骤 在提交 Issue 前请确保您已经完成了以下所有步骤
options: options:
- label: 已经查看了置顶 Issue 并搜索了现有的 Issue但没有找到类似的问题 - label: 理解 Issue 是用于反馈和解决问题的,而非吐槽评论区,将尽可能提供更多信息帮助问题解决
required: true required: true
- label: 正确填写了 Issue 标题 - label: 我确认自己需要的是提出问题并且讨论问题,而不是 Bug 反馈或需求建议
required: true required: true
- type: dropdown - type: dropdown

View File

@ -1,4 +1,4 @@
name: 🐛 Bug Report name: 🐛 Bug Report (English)
description: Create a report to help us improve description: Create a report to help us improve
title: '[Bug]: ' title: '[Bug]: '
labels: ['bug'] labels: ['bug']
@ -6,7 +6,8 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for taking the time to fill out this bug report! Thank you for taking the time to fill out this bug report!
Before submitting this issue, please make sure that you have understood the [FAQ](https://docs.cherry-ai.com/question-contact/questions) and [Knowledge Science](https://docs.cherry-ai.com/question-contact/knowledge)
- type: checkboxes - type: checkboxes
id: checklist id: checklist
@ -15,9 +16,11 @@ body:
description: | description: |
Before submitting an issue, please make sure you have completed the following steps Before submitting an issue, please make sure you have completed the following steps
options: options:
- label: I have viewed the pinned issues and searched existing issues but couldn't find anything similar. - 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 required: true
- label: I have filled out the issue title correctly. - 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.
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 required: true
- type: dropdown - type: dropdown
@ -45,7 +48,7 @@ body:
id: description id: description
attributes: attributes:
label: Bug Description label: Bug Description
description: A clear and concise description of what the bug is description: Please be as detailed as possible when describing the problem
placeholder: Tell us what happened... placeholder: Tell us what happened...
validations: validations:
required: true required: true
@ -54,7 +57,7 @@ body:
id: reproduction id: reproduction
attributes: attributes:
label: Steps To Reproduce label: Steps To Reproduce
description: Steps to reproduce the behavior description: Provide detailed steps to reproduce the issue so that our developers can reproduce the issue accurately
placeholder: | placeholder: |
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
@ -82,4 +85,4 @@ body:
id: additional id: additional
attributes: attributes:
label: Additional Context label: Additional Context
description: Add any other context about the problem here description: Anything that gives us a better understanding of the problem you're experiencing

View File

@ -1,4 +1,4 @@
name: 💡 Feature Request name: 💡 Feature Request (English)
description: Suggest an idea for this project description: Suggest an idea for this project
title: '[Feature]: ' title: '[Feature]: '
labels: ['enhancement'] labels: ['enhancement']
@ -6,7 +6,8 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for taking the time to suggest a new feature! Thank you for taking the time to submit a feature request!
Before submitting this issue, please make sure you have reviewed the [Project Roadmap](https://docs.cherry-ai.com/cherrystudio/planning) and the [Feature Overview](https://docs.cherry-ai.com/cherrystudio/preview).
- type: checkboxes - type: checkboxes
id: checklist id: checklist
@ -15,9 +16,13 @@ body:
description: | description: |
Before submitting an issue, please make sure you have completed the following steps Before submitting an issue, please make sure you have completed the following steps
options: options:
- label: I have viewed the pinned issues and searched existing issues but couldn't find anything similar. - 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 required: true
- label: I have filled out the issue title correctly. - 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.
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
- label: The latest version of Cherry Studio does not include the feature I am suggesting.
required: true required: true
- type: dropdown - type: dropdown
@ -44,28 +49,28 @@ body:
- type: textarea - type: textarea
id: problem id: problem
attributes: attributes:
label: Is your feature request related to a problem? label: Is your feature request related to an existing issue?
description: A clear and concise description of what the problem is description: Please briefly describe the problem you are experiencing.
placeholder: I'm always frustrated when... placeholder: I often feel frustrated because...
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: solution id: solution
attributes: attributes:
label: Describe the solution you'd like label: Desired Solution
description: A clear and concise description of what you want to happen description: Please briefly describe what you would like to happen.
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: alternatives id: alternatives
attributes: attributes:
label: Describe alternatives you've considered label: Alternative Solutions
description: A clear and concise description of any alternative solutions or features you've considered description: Please briefly describe any alternative solutions or features you have considered.
- type: textarea - type: textarea
id: additional id: additional
attributes: attributes:
label: Additional Context label: Additional Information
description: Add any other context or screenshots about the feature request here description: Add any other context or screenshots related to your feature request.

View File

@ -1,12 +1,12 @@
name: Question name: Discussion & Questions
description: Ask a question or seek help description: Seeking help, discussing issues, asking questions, etc...
title: '[Question]: ' title: '[Discussion]: '
labels: ['question'] labels: ['question']
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Thanks for asking a question! Please provide as much detail as possible so we can better assist you. Thank you for your question! Please describe your issue in as much detail as possible so that we can better assist you.
- type: checkboxes - type: checkboxes
id: checklist id: checklist
@ -15,9 +15,9 @@ body:
description: | description: |
Before submitting an issue, please make sure you have completed the following steps Before submitting an issue, please make sure you have completed the following steps
options: options:
- label: I have viewed the pinned issues and searched existing issues but couldn't find anything similar. - 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 required: true
- label: I have filled out the issue title correctly. - label: I confirm that I am here to ask questions and discuss issues, not to report bugs or request features.
required: true required: true
- type: dropdown - type: dropdown
@ -45,8 +45,8 @@ body:
id: question id: question
attributes: attributes:
label: Your Question label: Your Question
description: Please describe your question in detail description: Please describe your issue in detail.
placeholder: Please explain your question as clearly as possible... placeholder: Please explain your issue as clearly as possible...
validations: validations:
required: true required: true
@ -68,9 +68,9 @@ body:
id: priority id: priority
attributes: attributes:
label: Priority label: Priority
description: How urgent is this question for you? description: How urgent is this issue for you?
options: options:
- Low (Can wait) - Low (Review when available)
- Medium (Would like a response soon) - Medium (Would like a response soon)
- High (Blocking progress) - High (Blocking progress)
validations: validations: