Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To help with triaging, it's a good practice to automatically assign a bug label to issues created from this template. This will help filter and manage bug reports more efficiently.

Suggested change
labels: ''
labels: 'bug'

assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. Linux]
- Architecture [e.g x86_64]
Comment on lines +22 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To gather more comprehensive information for debugging, it's better to request more environment details. Renaming 'Desktop' to 'Environment' is more generic, and adding a field for the software version is crucial for reproducing bugs. I've also added a missing colon to Architecture for consistency.

Suggested change
**Desktop (please complete the following information):**
- OS: [e.g. Linux]
- Architecture [e.g x86_64]
**Environment (please complete the following information):**
- OS: [e.g. Linux]
- Architecture: [e.g. x86_64]
- Software Version: [e.g. v1.0.0]


**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To help categorize new feature requests and maintain a consistent format for issue titles, you could prefix the title with feat: . This is a common convention that aligns with practices like Conventional Commits.

Suggested change
title: ''
title: 'feat: '

labels: ''
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

It's helpful to automatically add a label to feature requests for better organization. The enhancement label is a common choice and helps with filtering and prioritizing work.

Suggested change
labels: ''
labels: 'enhancement'

assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.