chore: 为提出新功能或改进建议的 issue 模版添加必填描述和日志文件限制#1772
Merged
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
你好——我发现了 1 个问题，并提供了一些总体反馈：
- 将日志字段设为功能请求必填项可能有点过于严格，因为很多纯功能想法本身不会有相关日志；建议改为可选，或者仅在涉及具体行为时才是必填。
- 日志文本框的描述大量强调“区分缺陷和新功能”，在一个专门用于功能请求的模板里可能会让用户感到困惑；建议收紧文案，重点说明在什么情况下日志对功能提案真正有帮助。
- 在更新后的
additional描述中似乎有一个小拼写错误（“软件和游戏截图截图等”）；建议删去重复的“截图”。
给 AI Agent 的提示
Please address the comments from this code review:
## Overall Comments
- Making the logs field required for feature requests may be too strict, since many pure feature ideas won’t have relevant logs; consider making it optional or conditionally required based on whether behavior is involved.
- The logs textarea description heavily references distinguishing bugs vs new features, which might confuse users in a feature-request-specific template; consider tightening the wording to focus on when logs are truly useful for feature proposals.
- There appears to be a small typo in the updated `additional` description (`软件和游戏截图截图等`); consider removing the duplicated “截图”.
## Individual Comments
### Comment 1
<location path=".github/ISSUE_TEMPLATE/feature_request.yml" line_range="39" />
<code_context>
attributes:
label: 其他信息
- description: 日志、截图等
+ description: 软件和游戏截图截图等
validations:
required: false
</code_context>
<issue_to_address>
**nitpick (typo):** There’s a duplicated word in the Chinese description for additional information.
The phrase "软件和游戏截图截图等" repeats "截图". Consider changing it to "软件和游戏截图等" or "软件和游戏的截图等".
```suggestion
description: 软件和游戏截图等
```
</issue_to_address>帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续评审。
Original comment in English
Hey - I've found 1 issue, and left some high level feedback:
- Making the logs field required for feature requests may be too strict, since many pure feature ideas won’t have relevant logs; consider making it optional or conditionally required based on whether behavior is involved.
- The logs textarea description heavily references distinguishing bugs vs new features, which might confuse users in a feature-request-specific template; consider tightening the wording to focus on when logs are truly useful for feature proposals.
- There appears to be a small typo in the updated
additionaldescription (软件和游戏截图截图等); consider removing the duplicated “截图”.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Making the logs field required for feature requests may be too strict, since many pure feature ideas won’t have relevant logs; consider making it optional or conditionally required based on whether behavior is involved.
- The logs textarea description heavily references distinguishing bugs vs new features, which might confuse users in a feature-request-specific template; consider tightening the wording to focus on when logs are truly useful for feature proposals.
- There appears to be a small typo in the updated `additional` description (`软件和游戏截图截图等`); consider removing the duplicated “截图”.
## Individual Comments
### Comment 1
<location path=".github/ISSUE_TEMPLATE/feature_request.yml" line_range="39" />
<code_context>
attributes:
label: 其他信息
- description: 日志、截图等
+ description: 软件和游戏截图截图等
validations:
required: false
</code_context>
<issue_to_address>
**nitpick (typo):** There’s a duplicated word in the Chinese description for additional information.
The phrase "软件和游戏截图截图等" repeats "截图". Consider changing it to "软件和游戏截图等" or "软件和游戏的截图等".
```suggestion
description: 软件和游戏截图等
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Closed
MistEO
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
在功能请求问题模板中强制填写更完整的信息，以改进问题分诊流程，并更好地区分功能请求与缺陷（bug）。
新功能：
改进：
Original summary in English
Summary by Sourcery
Enforce more complete information in the feature request issue template to improve triage and distinguish feature requests from bugs.
New Features:
Enhancements: