docs: improve bug report template - #109
Conversation
Add structured sections for version info, reproduction steps, and expected vs actual behavior to help maintainers reproduce issues faster.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan includes up to 4 reviews per rolling hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe bug report template now collects Go version, operating system, project version, dependency versions, reproduction prerequisites, and additional context. It also separates issue details from environment information. ChangesBug report template
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change improves bug-report guidance without introducing actionable merge-blocking risk; it is merge-ready after normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/ISSUE_TEMPLATE/bug-report.md:
- Around line 14-22: Update the environment section in the bug-report template
so it does not claim the fields are required unless enforcement is implemented.
Either convert the template to a YAML issue form with validations.required
enabled for each environment field, or change the introductory “Required:”
wording to “Please provide” while preserving the existing fields.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 0b60d480-b03a-41be-ad52-170503847449
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug-report.md
Replace require with Please provide to ensure behavior is consistent with the prompts.
| **Operating system**: <!-- e.g. Linux / macOS / Windows --> | ||
|
|
||
| **Anything else we need to know?**: | ||
| **Project version**: <!-- e.g. v3.3.2 --> |
There was a problem hiding this comment.
[P2] 使用 Getty 的实际版本号示例
这个仓库的 tag/version 线是 v1.x（当前最新 tag 为 v1.5.2），v3.3.2 并不存在，容易让报错者把上层项目版本填进 Getty 版本字段。请把字段名明确成 Getty version，并把示例改成仓库实际发布的版本。
There was a problem hiding this comment.
感谢review，
- 已切换为getty的版本号示例v1.5.2
- 已将Project version 具体明确为 Getty version
2 participants
What this PR does:
Which issue(s) this PR fixes:
Fixes Part of #93
Special notes for your reviewer: N/A
Does this PR introduce a user-facing change?: N/A
Summary by CodeRabbit