improve feature and bug templates

This commit is contained in:
Christian Kellner
2025-08-25 21:10:01 +02:00
parent 44a84cc3f2
commit 0bf211cb93
3 changed files with 101 additions and 51 deletions

View File

@@ -1,43 +1,65 @@
name: Feature Request name: Bug Report
description: Suggest an improvement or new idea for Fredy description: Help us improve Fredy by reporting a bug
title: "[Feature]: " title: "[Bug]: "
labels: [enhancement] labels: [bug]
assignees: [] assignees: []
body: body:
- type: textarea - type: textarea
id: problem id: description
attributes: attributes:
label: Related Problem label: Bug Description
description: Is your feature request related to a problem? Describe it clearly. description: Provide a clear and concise description of the bug.
placeholder: "Example: Its difficult to do X when Y happens..." placeholder: e.g. "Fredy crashes when I click on Save."
validations:
required: false
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the feature you would like to see.
placeholder: "I would like Fredy to automatically..."
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: alternatives id: steps
attributes: attributes:
label: Alternatives Considered label: Steps to Reproduce
description: List any alternative solutions or workarounds youve tried or thought about. description: List the steps to reproduce the issue.
placeholder: "Instead of this, I also considered..." placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: "It should save without errors."
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
placeholder: "Fredy crashed with error XYZ."
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots / Logs
description: Add screenshots or paste log output to help explain the problem.
placeholder: "Drag and drop screenshots here, or paste logs."
validations: validations:
required: false required: false
- type: textarea - type: input
id: benefits id: environment
attributes: attributes:
label: Benefits label: Environment
description: Explain how this feature would improve Fredy or it's user experience. description: Provide details about your environment.
placeholder: "This would save users time by..." placeholder: "OS: macOS 15, Browser: Chrome 124, App version: 1.2.3"
validations: validations:
required: true required: true
@@ -45,7 +67,7 @@ body:
id: context id: context
attributes: attributes:
label: Additional Context label: Additional Context
description: Add any other context, examples, or screenshots that might help clarify your idea. description: Add any other context about the problem here.
placeholder: "Any other relevant information..." placeholder: "Any other information that might help..."
validations: validations:
required: false required: false

51
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@@ -0,0 +1,51 @@
name: Feature Request
description: Suggest an improvement or new idea for Fredy
title: "[Feature]: "
labels: [enhancement]
assignees: []
body:
- type: textarea
id: problem
attributes:
label: Related Problem
description: Is your feature request related to a problem? Describe it clearly.
placeholder: "Example: Its difficult to do X when Y happens..."
validations:
required: false
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the feature you would like to see.
placeholder: "I would like Fredy to automatically..."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: List any alternative solutions or workarounds youve tried or thought about.
placeholder: "Instead of this, I also considered..."
validations:
required: false
- type: textarea
id: benefits
attributes:
label: Benefits
description: Explain how this feature would improve Fredy or it's user experience.
placeholder: "This would save users time by..."
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context, examples, or screenshots that might help clarify your idea.
placeholder: "Any other relevant information..."
validations:
required: false

View File

@@ -1,23 +0,0 @@
---
name: Feature Request
about: Suggest an improvement or new idea for this project
title: "[Feature]: "
labels: enhancement
assignees: ''
---
## Related Problem
Is your feature request related to a problem? Please describe clearly.
Example: "I'm always frustrated when [...]"
## Proposed Solution
Describe the solution or feature youd like to see implemented.
## Alternatives Considered
List any alternative solutions or workarounds youve tried or thought about.
## Benefits
Explain how this feature would improve the project or user experience.
## Additional Context
Add any other context, examples, or screenshots that might help clarify your idea.