Skip to content

Commit 220df3f

Browse files
Christian KellnerChristian Kellner
authored andcommitted
improve bug/feature templates
1 parent 3a54ab0 commit 220df3f

File tree

2 files changed

+43
-28
lines changed

2 files changed

+43
-28
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,35 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
2+
name: Bug Report
3+
about: Help us improve by reporting an issue
4+
title: "[Bug]: "
5+
labels: bug
66
assignees: ''
77
---
88

9-
**Describe the bug**
10-
A clear and concise description of what the bug is.
11-
12-
**To Reproduce**
13-
Steps to reproduce the behavior:
9+
## Description
10+
Provide a clear and concise description of the bug.
1411

12+
## Steps to Reproduce
13+
List the steps to reproduce the issue, for example:
1514
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
15+
2. Click on '...'
16+
3. Scroll down to '...'
17+
4. Observe the error
18+
19+
## Expected Behavior
20+
Describe what you expected to happen instead.
21+
22+
## Actual Behavior
23+
Describe what actually happened.
24+
25+
## Screenshots / Logs
26+
If applicable, add screenshots or paste relevant log output to help explain the problem.
1927

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
28+
## Environment
29+
Please complete the following information (if relevant):
30+
- OS: [e.g. Windows 11, macOS 14, Ubuntu 22.04]
31+
- Browser [e.g. Chrome 124, Safari 17]
32+
- App/Service version [e.g. v1.2.3]
2233

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
34+
## Additional Context
35+
Add any other details that might help us understand or reproduce the issue.
Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
2+
name: Feature Request
3+
about: Suggest an improvement or new idea for this project
4+
title: "[Feature]: "
5+
labels: enhancement
66
assignees: ''
77
---
88

9-
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
## Related Problem
10+
Is your feature request related to a problem? Please describe clearly.
11+
Example: "I'm always frustrated when [...]"
1112

12-
**Describe the solution you'd like**
13-
A clear and concise description of what you want to happen.
13+
## Proposed Solution
14+
Describe the solution or feature you’d like to see implemented.
1415

15-
**Describe alternatives you've considered**
16-
A clear and concise description of any alternative solutions or features you've considered.
16+
## Alternatives Considered
17+
List any alternative solutions or workarounds youve tried or thought about.
1718

18-
**Additional context**
19-
Add any other context or screenshots about the feature request here.
19+
## Benefits
20+
Explain how this feature would improve the project or user experience.
21+
22+
## Additional Context
23+
Add any other context, examples, or screenshots that might help clarify your idea.

0 commit comments

Comments
 (0)