mirror of
https://github.com/onestardao/WFGY.git
synced 2026-05-02 05:21:36 +00:00
Revise bug report template for improved reporting
Updated bug report template to include structured fields for better clarity and detail.
This commit is contained in:
parent
965ec7557a
commit
4c2bd6389e
1 changed files with 68 additions and 30 deletions
98
.github/ISSUE_TEMPLATE/bug_report.md
vendored
98
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,38 +1,76 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
description: Report a real bug in repo content, links, templates, or project behavior.
|
||||
title: "[Bug] "
|
||||
labels:
|
||||
- bug
|
||||
- needs-triage
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Use this form for reproducible bugs.
|
||||
|
||||
---
|
||||
Good examples:
|
||||
- a broken link
|
||||
- a malformed template
|
||||
- a file that renders incorrectly
|
||||
- a content or structure bug in docs
|
||||
- a reproducible repo-level problem
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
- type: input
|
||||
id: affected_area
|
||||
attributes:
|
||||
label: Affected area
|
||||
description: Which page, template, file, or repo surface is affected
|
||||
placeholder: e.g. README, ECOSYSTEM_MAP, recognition_update.yml, config.yml
|
||||
validations:
|
||||
required: true
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
- type: textarea
|
||||
id: current_behavior
|
||||
attributes:
|
||||
label: Current behavior
|
||||
description: What is happening now
|
||||
placeholder: Describe the bug clearly
|
||||
validations:
|
||||
required: true
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
- type: textarea
|
||||
id: expected_behavior
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: What should happen instead
|
||||
placeholder: Describe the expected result
|
||||
validations:
|
||||
required: true
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Give a short reproducible path
|
||||
placeholder: |
|
||||
1. Open ...
|
||||
2. Click ...
|
||||
3. See ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
- type: textarea
|
||||
id: evidence
|
||||
attributes:
|
||||
label: Evidence
|
||||
description: Add screenshots, links, rendered output, or other useful context
|
||||
placeholder: Paste supporting details here
|
||||
validations:
|
||||
required: false
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I confirmed this is a bug, not a feature request or general question
|
||||
required: true
|
||||
- label: I included enough detail for someone else to reproduce or inspect the issue
|
||||
required: true
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue