Update issue templates #75
Conversation
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
WalkthroughA new bug report template has been added to the repository in the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant BugReportTemplate
participant Repository
User->>BugReportTemplate: Access bug report template
BugReportTemplate->>User: Display structured sections
User->>BugReportTemplate: Fill in bug description and details
User->>Repository: Submit bug report
Repository->>User: Acknowledge receipt of bug report
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://waps.l3s.uni-hannover.de/live/im_/https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (4)
.github/ISSUE_TEMPLATE/bug_report.md (4)
1-7: Consider enhancing the template metadataThe template could benefit from additional YAML fields to improve issue organization and user guidance:
- Add
bodyfield to provide a default template structure- Consider adding
type: bugfor better categorization--- name: Bug report about: Create a report to help us improve title: '' labels: bug assignees: '' +type: bug +body: | + ### Bug description + <!-- Describe what's happening --> + + ### Expected behavior + <!-- What did you expect to happen? --> ---
18-22: Clarify macOS version formatThe example provided might be confusing. Consider using a more standard macOS version format.
#### macOS version <!-- Go to Apple menu: About this mac --> -<!-- e.g Sequoia 15.0.1 --> +<!-- e.g. macOS Sonoma 14.1.1 -->
23-31: Consider grouping related settingsThe settings could be organized into logical groups for better clarity:
#### Settings <!-- Tick all the boxes to match your Swift Shift setup --> +<!-- General --> - [ ] Launch at login - [ ] Show menubar icon + +<!-- Behavior --> - [ ] Focus on window - [ ] Use quadrants - [ ] Require mouse click
1-39: Consider adding sections for additional debugging contextThe template would benefit from additional sections to help with debugging:
- System information (RAM, CPU)
- Related applications or processes that might interfere
- Logs or error messages
Would you like me to provide a complete template with these additional sections?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...uire mouse click #### Shortcuts Move: Click: ...(E_G)
[uncategorized] ~38-~38: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...-> Click: Resize: Click: <!-- if relevant -...(E_G)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug_report.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/ISSUE_TEMPLATE/bug_report.md
[uncategorized] ~35-~35: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...uire mouse click #### Shortcuts Move: Click: ...
(E_G)
[uncategorized] ~38-~38: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...-> Click: Resize: Click: <!-- if relevant -...
(E_G)
| ### Bug description | ||
|
|
||
| <!-- Describe what's happening --> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance bug description prompts
The bug description section would benefit from more specific prompts to help users provide complete information:
- Steps to reproduce
- Expected vs actual behavior
- Impact/severity
### Bug description
-<!-- Describe what's happening -->
+<!-- Please provide:
+1. Clear steps to reproduce the issue
+2. What you expected to happen
+3. What actually happened
+4. How often this occurs (always, sometimes, rare)
+-->📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Bug description | |
| <!-- Describe what's happening --> | |
| ### Bug description | |
| <!-- Please provide: | |
| 1. Clear steps to reproduce the issue | |
| 2. What you expected to happen | |
| 3. What actually happened | |
| 4. How often this occurs (always, sometimes, rare) | |
| --> |
| #### Shortcuts | ||
|
|
||
| Move: <!-- e.g cmd+alt --> | ||
| Click: <!-- if relevant --> | ||
|
|
||
| Resize: <!-- e.g cmd+shift --> | ||
| Click: <!-- if relevant --> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve shortcuts section formatting and structure
The shortcuts section needs formatting fixes and better structure:
- Fix "e.g." abbreviations
- Improve layout for clarity
#### Shortcuts
-Move: <!-- e.g cmd+alt -->
-Click: <!-- if relevant -->
+Move:
+- Shortcut: <!-- e.g., cmd+alt -->
+- Click required: <!-- Yes/No -->
-Resize: <!-- e.g cmd+shift -->
-Click: <!-- if relevant -->
+Resize:
+- Shortcut: <!-- e.g., cmd+shift -->
+- Click required: <!-- Yes/No -->📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### Shortcuts | |
| Move: <!-- e.g cmd+alt --> | |
| Click: <!-- if relevant --> | |
| Resize: <!-- e.g cmd+shift --> | |
| Click: <!-- if relevant --> | |
| #### Shortcuts | |
| Move: | |
| - Shortcut: <!-- e.g., cmd+alt --> | |
| - Click required: <!-- Yes/No --> | |
| Resize: | |
| - Shortcut: <!-- e.g., cmd+shift --> | |
| - Click required: <!-- Yes/No --> |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...uire mouse click #### Shortcuts Move: Click: ...
(E_G)
[uncategorized] ~38-~38: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...-> Click: Resize: Click: <!-- if relevant -...
(E_G)
Summary by CodeRabbit