Update issue templates #1
Conversation
WalkthroughThis pull request introduces two new GitHub issue templates to standardize reporting. One template is designed for bug reports and the other for feature requests. Each template provides structured sections for users to supply details such as reproduction steps, expected behavior, environment details, potential solutions, and supplementary context. These changes aim to improve the clarity and consistency of user-submitted issues. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant G as GitHub UI
participant R as Repository
U->>G: Click "New Issue"
G->>U: Display available templates
U->>G: Select Bug Report / Feature Request Template
G->>R: Load corresponding template
R-->>G: Serve structured issue form
G->>U: Present filled template for issue submission
Poem
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:
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 (2)
.github/ISSUE_TEMPLATE/bug_report.md (2)
26-29: Fix Unordered List Indentation for Desktop Details
Markdownlint (MD007) suggests that unordered list items should have no leading indentation. Please remove the extra spaces before the '-' characters on lines 27–29.- - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22]🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
31-35: Fix Unordered List Indentation for Smartphone Details
Similarly, the smartphone details list should have no leading whitespace. Removing the spaces before each '-' will resolve the markdown lint warning.- - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22]🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
32-32: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
📜 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)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/bug_report.md
27-27: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
28-28: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (5)
.github/ISSUE_TEMPLATE/bug_report.md (3)
1-8: YAML Front Matter is Well-Structured
The front matter metadata (name, about, title, labels, assignees) is correctly formatted and provides the necessary context for this template.
10-25: Clear Section Headings and Instructions
The sections for describing the bug, reproduction steps, expected behavior, and screenshots are clear and guide users effectively.
37-38: Additional Context Section is Concise
The "Additional context" section is succinct and invites further details about the problem effectively..github/ISSUE_TEMPLATE/feature_request.md (2)
1-8: YAML Front Matter is Correct for Feature Request
The metadata for the feature request template (name, about, title, labels, assignees) is properly structured and complete.
10-21: Clear and Structured Feature Request Content
The sections prompt users to explain the problem, describe the desired solution, consider alternatives, and add additional context—all of which facilitate a well-detailed feature request.
Summary by CodeRabbit