docs: issue template update [no ci] #17753
Conversation
Walkthrough本次更新主要针对 GitHub Issue 模板及贡献指南文档进行了调整，包括优化模板的中英文说明、必填项校验方式、命名与格式细节，以及更新 Node.js 和 pnpm 的推荐版本要求。同时，.gitignore 新增了对 "chrome" 的忽略规则。 Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub Issue Template
User ->> GitHub Issue Template: 打开 Bug 或 Feature Request 模板
GitHub Issue Template -->> User: 展示中英文说明及必填项
User ->> GitHub Issue Template: 勾选“已搜索并确定不是重复提交”
User ->> GitHub Issue Template: 填写复现步骤（必填）
GitHub Issue Template -->> User: 校验必填项，允许提交
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 30th. To opt out, configure 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 (4)
.gitignore (1)
87-87: 添加“chrome”到忽略列表
已在.gitignore中新增chrome规则，这有助于忽略所有名为chrome的文件或目录。如项目中仅需忽略根目录的chrome文件夹，可考虑改为chrome/或使用路径前缀提高精确度。.github/ISSUE_TEMPLATE/config.yml (1)
17-17: 在文件末尾添加换行符
YAMLlint 报告文件末尾缺少换行字符，建议在最后一行后加一条空行以遵循 POSIX 文件格式要求。🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 17-17: no new line character at the end of file
(new-line-at-end-of-file)
.github/ISSUE_TEMPLATE/feature_request.yml (1)
1-1: 修复行结束符
YAMLlint 提示该文件使用了错误的行结束符，建议统一为 Unix 风格\n。🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 1-1: wrong new line character: expected \n
(new-lines)
CONTRIBUTING.md (1)
127-127: 优化句式表达
“关于拉取请求”作为介词短语建议改为“对于拉取请求”或将其置于句首，以符合汉语表达习惯。🧰 Tools
🪛 LanguageTool
[uncategorized] ~127-~127: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...equest > 如果对 PR（Pull Request）不了解，请阅读 [《关于拉取请求》](https://docs.github.com/zh/pull-r...(wb2)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.github/ISSUE_TEMPLATE/bug_report.yml(3 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks).github/ISSUE_TEMPLATE/feature_request.yml(2 hunks).gitignore(1 hunks)CONTRIBUTING.md(5 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/ISSUE_TEMPLATE/config.yml
[error] 17-17: no new line character at the end of file
(new-line-at-end-of-file)
.github/ISSUE_TEMPLATE/feature_request.yml
[error] 1-1: wrong new line character: expected \n
(new-lines)
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~127-~127: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...equest > 如果对 PR（Pull Request）不了解，请阅读 [《关于拉取请求》](https://docs.github.com/zh/pull-r...
(wb2)
🔇 Additional comments (11)
.github/ISSUE_TEMPLATE/config.yml (1)
3-15: 统一模板名称的空格格式
在name字段的 emoji 后增加了空格，使各 Issue 模板名称在侧边栏中显示格式一致。.github/ISSUE_TEMPLATE/feature_request.yml (2)
1-2: 添加中英双语模板名称与描述
已在name与description字段中加入英文翻译，提升全球贡献者的可读性。🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 1-1: wrong new line character: expected \n
(new-lines)
11-14: 调整“非重复确认”复选框及必填项
将复选框标签改为“请先确认”，并将required验证移至单个选项，确保提交者必须手动确认该 Issue 非重复，符合最佳实践。CONTRIBUTING.md (5)
5-5: 合并“Pull Request 贡献指南”
已移除独立的“Issue 报告指南”部分，仅保留“Pull Request 贡献指南”，简化文档结构，更聚焦于 PR 贡献流程。
9-9: 更新 Node.js 与 pnpm 推荐版本
将 Node.js 推荐版本从16.20.0+升级至20.19.2+，并将 pnpm 推荐版本从7更新为10，对齐当前 LTS 与社区生态，建议验证 CI 与锁版本配置的兼容性。
35-35: 更新npm link文档链接版本
将npm link文档链接从 v7 版本升级到 v11，确保命令示例指向最新官方文档。
113-113: 修复命令示例拼写
将快照更新命令从runupdateSnapshot修正为run updateSnapshot，补充缺失空格，命令示例更易读且正确。
214-214: 添加社区二维码链接
在文档末尾加入开发者社区二维码链接，方便贡献者加入交流，提升社区互动。.github/ISSUE_TEMPLATE/bug_report.yml (3)
1-2: 中英双语模板名称
已将模板名称更新为🐞 错误报告 Bug Report，增强国际化可读性。
11-14: 调整“非重复确认”复选框
将label更新为“请先确认”，并为选项我已搜索并确定这个提交不是重复的添加required: true，保证用户明确确认该 Issue 非重复。
73-74: 强制“复现步骤”字段为必填
在repro-steps文本区域中新增validations.required: true，确保提交问题时附上复现步骤，提高问题可诊断性。
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17753 +/- ##
========================================
Coverage 59.37% 59.37%
========================================
Files 387 387
Lines 23417 23417
Branches 5141 5140 -1
========================================
Hits 13903 13903
- Misses 8020 8186 +166
+ Partials 1494 1328 -166
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Co-authored-by: Amumu <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
214-214: 建议改为 HTTPS 链接
当前社区二维码使用了 HTTP 协议，建议改为https://storage.jd.com/...以提升安全性。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~127-~127: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...equest > 如果对 PR（Pull Request）不了解，请阅读 [《关于拉取请求》](https://docs.github.com/zh/pull-r...
(wb2)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Build Rust Binding / stable - x86_64-unknown-linux-gnu
- GitHub Check: Build Rust Binding / stable - aarch64-apple-darwin
- GitHub Check: Build Rust Binding / stable - x86_64-unknown-linux-musl
- GitHub Check: Build Rust Binding / stable - x86_64-pc-windows-msvc
- GitHub Check: Build Rust Binding / stable - x86_64-apple-darwin
- GitHub Check: Build Rust WASM / stable - wasm32-wasi
🔇 Additional comments (4)
CONTRIBUTING.md (4)
1-214: PR 描述与文档变更不一致
当前 PR 目标声称仅更新 Issue 模板，但本次提交却对 CONTRIBUTING.md 做了多项重大修改（如 Node.js/PNPM 版本升级、链接及命令修正等），建议同步更新 PR 描述以准确反映所有更改内容。Likely an incorrect or invalid review comment.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~127-~127: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...equest > 如果对 PR（Pull Request）不了解，请阅读 [《关于拉取请求》](https://docs.github.com/zh/pull-r...(wb2)
[uncategorized] ~160-~160: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...anges 或重要修改时，请及时新增、修改对应的文档。 关于文档的开发请阅读下一章节：《贡献文档》。 ### 10. Rust 部分 Taro 仓库里有部分使用...(wa5)
🪛 markdownlint-cli2 (0.17.2)
117-117: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
118-118: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
119-119: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
177-177: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
35-35: 链接更新无误，感谢修正
npm link 已指向 v11 文档，yarn link 与 pnpm link 也都使用了官方对应版本的 HTTPS 链接，文档链接准确可用。
113-113: Snapshot 命令修正正确
run updateSnapshot的空格已补充，命令可直接复制执行，符合测试快照更新流程。
127-127: 中文 PR 文档链接已更新
链接已从英文版切换为中文版《关于拉取请求》，文本和 URL 均无误。🧰 Tools
🪛 LanguageTool
[uncategorized] ~127-~127: “关于”组成的介词短语必需位于句首，或请改用"对于"代替。
Context: ...equest > 如果对 PR（Pull Request）不了解，请阅读 [《关于拉取请求》](https://docs.github.com/zh/pull-r...(wb2)
|
|
||
| ### 1. 环境准备 | ||
|
|
||
| > 需要安装 [Node.js 16](https://nodejs.org/en/)（建议安装 `16.20.0` 及以上版本）及 [pnpm 7](https://pnpm.io/zh/installation) | ||
| > 需要安装 [Node.js 20](https://nodejs.org/en/)（建议安装 `20.19.2` 及以上版本）及 [pnpm 10](https://pnpm.io/zh/installation) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
校验 Node.js 版本一致性
已将 Node.js 要求提升为 20.19.2+，请确认仓库中 .nvmrc、package.json 的 engines.node 字段以及 CI workflow（.github/workflows）中的 Node 版本配置已同步更新。
🏁 Script executed:
#!/bin/bash
# 检查 .nvmrc
if [ -f .nvmrc ]; then
echo ".nvmrc 内容: $(cat .nvmrc)"
else
echo "未找到 .nvmrc 文件"
fi
# 检查 package.json 中 engines.node
jq '.engines.node // "未设置 engines.node"' package.json
# 检索 GitHub CI 中 node-version 配置
rg -n '"node-version"' .github/workflows || echo "CI workflow 中未找到 node-version 配置"Length of output: 249
请同步更新 Node.js 版本配置以保持一致性
文档已将 Node.js 要求提升至 20.19.2+，但当前项目中尚未同步以下配置，请补充并确认：
- 在项目根目录新增或更新
.nvmrc，内容写为：20.19.2 - 在
package.json中添加或更新engines.node："engines": { "node": ">=20.19.2" }
- 在
.github/workflows/下的 CI workflow 文件中，将node-version或setup-node的node-version参数更新为20.19.2及以上
完成后，请再次验证本地与 CI 均能正确使用 Node.js 20.19.2+。
🤖 Prompt for AI Agents
In CONTRIBUTING.md at line 9, the Node.js version requirement was updated to
20.19.2+, but the project configuration files are not consistent. To fix this,
create or update the .nvmrc file in the project root to contain "20.19.2", add
or update the "engines.node" field in package.json to ">=20.19.2", and update
all node-version settings in the CI workflow files under .github/workflows/ to
"20.19.2" or higher. After these changes, verify that both local and CI
environments use Node.js 20.19.2 or above correctly.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
这个 PR 做了什么？ (简要描述所做更改)
强制确认是否重复提交；强制输入复现步骤
这个 PR 是什么类型？ (至少选择一个)
这个 PR 涉及以下平台：
Summary by CodeRabbit
文档
杂项