Skip to content

Commit 0bf211c

Browse files
Christian KellnerChristian Kellner
authored andcommitted
improve feature and bug templates
1 parent 44a84cc commit 0bf211c

File tree

3 files changed

+97
-47
lines changed

3 files changed

+97
-47
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 46 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,73 @@
1-
name: Feature Request
2-
description: Suggest an improvement or new idea for Fredy
3-
title: "[Feature]: "
4-
labels: [enhancement]
1+
name: Bug Report
2+
description: Help us improve Fredy by reporting a bug
3+
title: "[Bug]: "
4+
labels: [bug]
55
assignees: []
66

77
body:
88
- type: textarea
9-
id: problem
9+
id: description
1010
attributes:
11-
label: Related Problem
12-
description: Is your feature request related to a problem? Describe it clearly.
13-
placeholder: "Example: It’s difficult to do X when Y happens..."
11+
label: Bug Description
12+
description: Provide a clear and concise description of the bug.
13+
placeholder: e.g. "Fredy crashes when I click on Save."
1414
validations:
15-
required: false
15+
required: true
1616

1717
- type: textarea
18-
id: solution
18+
id: steps
1919
attributes:
20-
label: Proposed Solution
21-
description: Describe the feature you would like to see.
22-
placeholder: "I would like Fredy to automatically..."
20+
label: Steps to Reproduce
21+
description: List the steps to reproduce the issue.
22+
placeholder: |
23+
1. Go to '...'
24+
2. Click on '...'
25+
3. Scroll down to '...'
26+
4. See error
2327
validations:
2428
required: true
2529

2630
- type: textarea
27-
id: alternatives
31+
id: expected
2832
attributes:
29-
label: Alternatives Considered
30-
description: List any alternative solutions or workarounds you’ve tried or thought about.
31-
placeholder: "Instead of this, I also considered..."
33+
label: Expected Behavior
34+
description: What did you expect to happen?
35+
placeholder: "It should save without errors."
3236
validations:
33-
required: false
37+
required: true
3438

3539
- type: textarea
36-
id: benefits
40+
id: actual
41+
attributes:
42+
label: Actual Behavior
43+
description: What actually happened?
44+
placeholder: "Fredy crashed with error XYZ."
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: screenshots
50+
attributes:
51+
label: Screenshots / Logs
52+
description: Add screenshots or paste log output to help explain the problem.
53+
placeholder: "Drag and drop screenshots here, or paste logs."
54+
validations:
55+
required: false
56+
57+
- type: input
58+
id: environment
3759
attributes:
38-
label: Benefits
39-
description: Explain how this feature would improve Fredy or it's user experience.
40-
placeholder: "This would save users time by..."
60+
label: Environment
61+
description: Provide details about your environment.
62+
placeholder: "OS: macOS 15, Browser: Chrome 124, App version: 1.2.3"
4163
validations:
4264
required: true
4365

4466
- type: textarea
4567
id: context
4668
attributes:
4769
label: Additional Context
48-
description: Add any other context, examples, or screenshots that might help clarify your idea.
49-
placeholder: "Any other relevant information..."
70+
description: Add any other context about the problem here.
71+
placeholder: "Any other information that might help..."
5072
validations:
5173
required: false

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature Request
2+
description: Suggest an improvement or new idea for Fredy
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
assignees: []
6+
7+
body:
8+
- type: textarea
9+
id: problem
10+
attributes:
11+
label: Related Problem
12+
description: Is your feature request related to a problem? Describe it clearly.
13+
placeholder: "Example: It’s difficult to do X when Y happens..."
14+
validations:
15+
required: false
16+
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Proposed Solution
21+
description: Describe the feature you would like to see.
22+
placeholder: "I would like Fredy to automatically..."
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Alternatives Considered
30+
description: List any alternative solutions or workarounds you’ve tried or thought about.
31+
placeholder: "Instead of this, I also considered..."
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: benefits
37+
attributes:
38+
label: Benefits
39+
description: Explain how this feature would improve Fredy or it's user experience.
40+
placeholder: "This would save users time by..."
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: context
46+
attributes:
47+
label: Additional Context
48+
description: Add any other context, examples, or screenshots that might help clarify your idea.
49+
placeholder: "Any other relevant information..."
50+
validations:
51+
required: false

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)