Update issue templates #93
Conversation
WalkthroughA new bug report and feature request template have been added to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 1
🧹 Nitpick comments (5)
.github/ISSUE_TEMPLATE/bug_report.md (5)
1-8: Consider adding default labels for bug reports.Adding default labels like
bugortriagewould help with issue organization and workflow automation.name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: 'bug,triage' assignees: ''
10-13: Add character limit guidance for the summary.Consider adding a recommended character limit to encourage concise descriptions.
## Summary -Provide a concise description of the issue. +Provide a concise description of the issue (recommended: 200 characters or less). *Example: The app crashes when uploading files to Google Drive.*
22-27: Add browser information field for web-related issues.Since some issues might be web-related, including browser information would be helpful.
## Environment Details - **App Version**: [e.g., 1.0.5] - **Device**: [e.g., Pixel 7, iPhone 14 Pro] - **OS Version**: [e.g., Android 13, iOS 17] - **Network**: [e.g., Wi-Fi, Mobile Data] +- **Browser** (if applicable): [e.g., Chrome 119, Safari 17]🧰 Tools
🪛 Markdownlint (0.37.0)
22-22: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
28-39: Fix markdown formatting issues.The headings have extra spaces after the hash symbols, which violates markdown best practices.
-## Screenshots or Logs (Optional) +## Screenshots or Logs (Optional) -## Related Issues or Discussions +## Related Issues or Discussions🧰 Tools
🪛 Markdownlint (0.37.0)
28-28: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
32-32: null
Multiple spaces after hash on atx style heading(MD019, no-multiple-space-atx)
40-42: Enhance the pre-submission checklist.The checklist could be more comprehensive and should fix the markdown formatting.
-## ⚠️ Before submitting, ensure: +## ⚠️ Before Submitting - [ ] The issue hasn't already been reported. - [ ] You're using the latest version of the app. +- [ ] You've included all required environment details. +- [ ] You've provided clear reproduction steps. +- [ ] You've searched existing issues and discussions.🧰 Tools
🪛 Markdownlint (0.37.0)
40-40: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/bug_report.md(1 hunks).github/ISSUE_TEMPLATE/feature_request.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/ISSUE_TEMPLATE/feature_request.md
🧰 Additional context used
🪛 Markdownlint (0.37.0)
.github/ISSUE_TEMPLATE/bug_report.md
22-22: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
28-28: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
32-32: null
Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
40-40: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
Summary by CodeRabbit