fix: 先补齐可复现的 Bug 信息，再决定是否需要代码修复 (#1239) - #1244
Conversation
github-actions
Bot
added
ci/cd
documentation
🤖 自动审查报告
📁 修改的文件
🧠 AI 代码审查意见结论Ready to Merge 结构化结果
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4afb7726cb
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| validations: | ||
| required: true |
There was a problem hiding this comment.
These required validations only run when the reporter chooses this new Bug Report form; I checked .github/ISSUE_TEMPLATE/config.yml, and blank_issues_enabled: true still leaves GitHub's “Open a blank issue” path available, so external users can bypass every required commit/log/reproduction field that this change is meant to collect. If the goal is to make reproducible bug context mandatory before triage, update the template chooser config (and cover it in this test) so blank issues are not offered to contributors.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
This PR improves bug-report quality and reproducibility by migrating the repository’s bug report template from a free-form Markdown template to a structured GitHub Issue Form, and adds a test to enforce required fields and prevent template drift.
Changes:
- Replace
.github/ISSUE_TEMPLATE/bug_report.mdwith a structured.github/ISSUE_TEMPLATE/bug_report.ymlissue form. - Require key reproducibility fields (commit hashes, repro steps, expected/actual behavior, logs, environment, config) via issue-form validations.
- Add a test to ensure the YAML form exists, the Markdown bug template is removed, and required fields remain required.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/bug_report.yml |
Introduces a structured bug report issue form with required reproducibility fields. |
.github/ISSUE_TEMPLATE/bug_report.md |
Removes the legacy Markdown bug report template to avoid ambiguous/partial reports. |
tests/test_issue_templates.py |
Adds a static regression test to enforce the single bug-report form and required fields. |
ZhuLinsen
left a comment
ZhuLinsen
left a comment
There was a problem hiding this comment.
评审结论
- 必要性：通过，本 PR 把自由文本 Bug 模板改为必填 Issue Form，并关闭 blank issue，能直接改善 #1239 中“信息不足无法复现”的处理成本。
- 是否有对应 issue：有，Closes #1239。
- PR 类型：fix，修复的是 Bug 提交流程缺少强约束导致复现信息不足的问题，不涉及运行时代码修复。
- description 完整性：完整，已说明背景、范围、验证命令、风险和回滚方案；未更新 README/docs/CHANGELOG 的说明对本次 GitHub Issue 模板类变更可接受。
- 是否可直接合入：可，当前 CI 通过，改动范围集中在
.github/ISSUE_TEMPLATE和模板测试；mergeable_state=blocked在本仓库分支保护语义下不单独构成阻断。
🤖 此回复由 OpenReview Bot 自动生成，仅供参考。如有疑问请 @维护者。
4559395 to
d07975d
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d07975d5ae
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,117 @@ | |||
| name: Bug 报告 / Bug Report | |||
There was a problem hiding this comment.
This changes the contributor-facing issue filing flow by replacing the Markdown bug template with a required issue form and disabling blank issues, but the diff does not update docs/CHANGELOG.md. The repository rule in AGENTS.md says user-visible capability or workflow changes must be recorded in docs/CHANGELOG.md, so this PR should add an [Unreleased] entry to keep release notes and contributor workflow history in sync.
Useful? React with 👍 / 👎.
PR Type
Background And Problem
+176 / -66。Scope Of Change
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/config.ymldocs/CHANGELOG.mdtests/test_issue_templates.pyDocumentation And Changelog
docs/CHANGELOG.md。README.md或专题文档；如用户可见行为发生变化，请补充文档落点。Issue Link
Closes #1239
Verification Commands And Results
关键输出/结论 / Key output & conclusion:
Compatibility And Risk
.github/ISSUE_TEMPLATE/bug_report.md,.github/ISSUE_TEMPLATE/bug_report.yml,.github/ISSUE_TEMPLATE/config.yml,docs/CHANGELOG.md,tests/test_issue_templates.py，未识别额外兼容性风险。Rollback Plan
git revert <merge-commit>回滚本 PR 提交，重点确认.github/ISSUE_TEMPLATE/bug_report.md,.github/ISSUE_TEMPLATE/bug_report.yml,.github/ISSUE_TEMPLATE/config.yml,docs/CHANGELOG.md恢复正常。Acceptance Criteria
Checklist
docs/CHANGELOG.md同步仍需确认；如涉及用户可见变更，请在合并前补充原因与文档落点 / Documentation anddocs/CHANGELOG.mdsync still needs confirmation before merge when user-visible behavior changes