chore: update issue template #17655
chore: update issue template #17655
Conversation
Walkthrough本次更新主要对 GitHub 的 issue 和 pull request 模板进行了优化，包括描述文本、标签、输入方式及字段的调整，新增了用户意向反馈选项，并完善了 issue 配置文件中的联系入口。这些更改提升了表单结构化和用户交互体验。 Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub Issue Template
User->>GitHub Issue Template: 打开 issue 模板
GitHub Issue Template-->>User: 展示优化后的表单（多选平台、贡献代码等）
User->>GitHub Issue Template: 填写并提交 issue
GitHub Issue Template-->>User: 收集结构化信息并创建 issue
Possibly related PRs
Suggested reviewers
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
.github/ISSUE_TEMPLATE/bug_report.yml (1)
81-81: 文件末尾缺少空行
请在文件末尾添加换行符以符合 YAMLlint 要求。🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 81-81: no new line character at the end of file
(new-line-at-end-of-file)
.github/PULL_REQUEST_TEMPLATE.md (1)
21-31: 更新平台复选列表
平台列表已与 issue 模板保持一致，可考虑提取公共片段以减少重复维护。.github/ISSUE_TEMPLATE/feature_request.yml (1)
32-32: 文件末尾缺少空行
请在文件末尾添加换行，以满足 YAMLlint 要求。🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 32-32: no new line character at the end of file
(new-line-at-end-of-file)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/ISSUE_TEMPLATE/bug_report.yml(3 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks).github/ISSUE_TEMPLATE/feature_request.yml(1 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/ISSUE_TEMPLATE/bug_report.yml
[error] 81-81: no new line character at the end of file
(new-line-at-end-of-file)
.github/ISSUE_TEMPLATE/feature_request.yml
[error] 32-32: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build Rust Binding / stable - x86_64-pc-windows-msvc
🔇 Additional comments (19)
.github/ISSUE_TEMPLATE/config.yml (3)
3-5: 确认“创建提案”链接
已新增指向RFC讨论分类的链接，请校验该 URL 是否正确且可用。
6-8: 确认“发起投票”链接
已新增指向polls讨论分类的链接，请校验该 URL 是否正确且可用。
10-11: 更新“社区支持”链接
已将链接从通用社区讨论调整为Q&A分类，描述更精准，确认 URL 无误。.github/ISSUE_TEMPLATE/bug_report.yml (5)
2-2: 简化问题描述
已将description更新为“报告新 Bug”，更简洁明确。
5-5: 更新标签“待分类”至“triage”
将 label 从待分类改为triage，与其他模板保持一致。
8-23: 扩展“相关平台”多选项
将 platform 字段改为复选框，提供丰富的预设平台列表，有助于标准化数据。
64-66: 优化“复现步骤”多行占位符
调整 placeholder 的 YAML 格式为>-，并加入有序列表示例，使填写体验更友好。
76-81: 新增“贡献代码”复选项
允许用户在报告 Bug 时表明是否愿意修复，增强社区协作。🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 81-81: no new line character at the end of file
(new-line-at-end-of-file)
.github/PULL_REQUEST_TEMPLATE.md (5)
2-3: 更新贡献者指南链接与操作说明
合并贡献者指南链接并补充 “将 "[ ]" 更新为 "[x]"” 提示，指导更明确。
5-5: 新增 PR 摘要标题提示
使用**这个 PR 做了什么？**小标题，引导撰写变更概述，推荐保留。
8-8: 简化 PR 类型选择
整合并清晰列出多种 PR 类型复选框，去除冗余内容，提升可读性。
10-17: 精炼 PR 类型列表
各类型选项齐全，中文与英文描述对齐，无需调整。
19-19: 新增平台影响小节
**这个 PR 涉及以下平台：**指引清晰，有助于评估兼容性。.github/ISSUE_TEMPLATE/feature_request.yml (6)
2-2: 简化功能请求描述
将description更新为“提出新特性”，更简洁易懂。
5-6: 更新标签为 triage/feat
将原待分类、feature改为triage、feat，与其他模板保持一致。
12-12: 完善功能描述提示
将label和description修改为更详细的“这个功能增加了什么特性？解决了什么问题？”。
16-19: 重命名 design 字段并更新提示
将 id 从details改为design，label 更新为“功能设计”，更契合使用场景。
22-26: 新增实现细节字段
添加details文本区域，收集具体实现思路，完善模板。
27-32: 新增“贡献代码”复选选项
与 bug 报告模板对称，支持用户标记愿意实现特性，增强协作。🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 32-32: no new line character at the end of file
(new-line-at-end-of-file)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17655 +/- ##
========================================
Coverage 59.37% 59.37%
========================================
Files 387 387
Lines 23417 23417
Branches 5150 5145 -5
========================================
Hits 13903 13903
- Misses 8013 8148 +135
+ Partials 1501 1366 -135
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
@tutuxxx 之前的 discussion 链接放错了，抽空合一下哈 |
|
@tutuxxx 为了使issue更规范，请尽快合并一下哈 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/ISSUE_TEMPLATE/bug_report.yml (1)
87-87: 文件末尾缺少换行符
请在文件末尾添加一个空行以满足 YAMLlint 要求。+⏎🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 87-87: no new line character at the end of file
(new-line-at-end-of-file)
.github/ISSUE_TEMPLATE/feature_request.yml (1)
40-40: 文件末尾缺少换行符
请在文件末尾添加一个空行以满足 YAMLlint 要求。+⏎🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 40-40: no new line character at the end of file
(new-line-at-end-of-file)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/bug_report.yml(3 hunks).github/ISSUE_TEMPLATE/feature_request.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/ISSUE_TEMPLATE/feature_request.yml
[error] 40-40: no new line character at the end of file
(new-line-at-end-of-file)
.github/ISSUE_TEMPLATE/bug_report.yml
[error] 87-87: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (12)
.github/ISSUE_TEMPLATE/bug_report.yml (5)
2-2: 描述文本更新简洁明了
将 description 修改为“报告新 Bug”，更符合中文语境，能让用户快速理解该模板作用。
5-5: 标签triage替换恰当
将原来的“待分类”改为“triage”，与项目中统一的 label 规范保持一致。
8-13: 新增非重复确认复选框
添加“请先搜索是否存在类似提交”及“我确定这个提交不是重复的”选项，且已设为必填，有助于减少重复 issue。
16-31: 平台多选项更新完善
将单一输入字段替换为多选复选框，列举了所有主要平台，增强了 issue 上报时的平台信息收集。
82-87: 新增“贡献代码”复选框
加入“我愿意修复这个错误”选项，便于征集社区贡献者。🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 87-87: no new line character at the end of file
(new-line-at-end-of-file)
.github/ISSUE_TEMPLATE/feature_request.yml (7)
2-2: 描述文本更新简洁明了
“提出新特性”比原描述更精炼，符合模板风格。
5-6: 标签更新为triage和feat
将“待分类”替换为“triage”，“feature”替换为“feat”，与 bug 模板保持一致。
8-15: 新增非重复确认复选框
已添加“请先搜索是否存在类似提交”复选框并强制填写，有助于避免重复请求。
20-20: 功能描述占位文本优化
“这个功能增加了什么特性？解决了什么问题？”更聚焦于 feature 的目的与价值。
24-27: “功能设计”字段完善
“id: design” 对应“功能设计”并设为必填，可让贡献者了解 API/CLI 等使用方式。
30-34: 新增“实现细节”字段
提供实现思路的文本框，利于社区评估方案可行性。
35-40: 新增贡献者意愿复选框
“我愿意实现这个功能”选项便于招募社区协作。🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 40-40: no new line character at the end of file
(new-line-at-end-of-file)
|
@yoyo837 可否帮忙合一下 🙏 |
| @@ -1,17 +1,34 @@ | |||
| name: 错误报告 🐞 | |||
| description: >- | |||
| 创建一个新的错误报告。对于一般性问题，请在 GitHub Discussion 中发布。 | |||
| description: 报告新 Bug | |||
这个 PR 做了什么? (简要描述所做更改)
更新了 issue template，修复了 config.yml 中的错误链接
这个 PR 是什么类型? (至少选择一个)
这个 PR 涉及以下平台:
Summary by CodeRabbit