mirror of
https://github.com/orangecoding/fredy.git
synced 2026-06-16 12:31:07 +00:00
improve feature and bug templates
This commit is contained in:
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,35 +0,0 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Help us improve by reporting an issue
|
||||
title: "[Bug]: "
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Description
|
||||
Provide a clear and concise description of the bug.
|
||||
|
||||
## Steps to Reproduce
|
||||
List the steps to reproduce the issue, for example:
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. Scroll down to '...'
|
||||
4. Observe the error
|
||||
|
||||
## Expected Behavior
|
||||
Describe what you expected to happen instead.
|
||||
|
||||
## Actual Behavior
|
||||
Describe what actually happened.
|
||||
|
||||
## Screenshots / Logs
|
||||
If applicable, add screenshots or paste relevant log output to help explain the problem.
|
||||
|
||||
## Environment
|
||||
Please complete the following information (if relevant):
|
||||
- OS: [e.g. Windows 11, macOS 14, Ubuntu 22.04]
|
||||
- Browser [e.g. Chrome 124, Safari 17]
|
||||
- App/Service version [e.g. v1.2.3]
|
||||
|
||||
## Additional Context
|
||||
Add any other details that might help us understand or reproduce the issue.
|
||||
51
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
51
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal 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: It’s 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 you’ve 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
|
||||
Reference in New Issue
Block a user