mirror of
https://github.com/orangecoding/fredy.git
synced 2026-06-16 12:31:07 +00:00
improve bug/feature templates
This commit is contained in:
43
.github/ISSUE_TEMPLATE/bug_report.md
vendored
43
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,24 +1,35 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
name: Bug Report
|
||||
about: Help us improve by reporting an issue
|
||||
title: "[Bug]: "
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
## 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. See error
|
||||
2. Click on '...'
|
||||
3. Scroll down to '...'
|
||||
4. Observe the error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
## Expected Behavior
|
||||
Describe what you expected to happen instead.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
## 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.
|
||||
|
||||
28
.github/ISSUE_TEMPLATE/feature_request.md
vendored
28
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,19 +1,23 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
name: Feature Request
|
||||
about: Suggest an improvement or new idea for this project
|
||||
title: "[Feature]: "
|
||||
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 [...]
|
||||
## Related Problem
|
||||
Is your feature request related to a problem? Please describe clearly.
|
||||
Example: "I'm always frustrated when [...]"
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
## Proposed Solution
|
||||
Describe the solution or feature you’d like to see implemented.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
## Alternatives Considered
|
||||
List any alternative solutions or workarounds you’ve tried or thought about.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
## 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.
|
||||
|
||||
Reference in New Issue
Block a user