Skip to content

Commit

Permalink
Issue Templates: update bug report template (#1048)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeherve authored Jan 14, 2025
1 parent b73041b commit 60f21f9
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 36 deletions.
84 changes: 49 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,51 +26,66 @@ body:
attributes:
label: Steps to reproduce
placeholder: |
E.g., What happened, and what did you expect to happen? Add images,
GIFs, and videos if you have them on hand.
1. Start at `site-domain.com/blog`.
2. Click on any blog post.
3. ...
Add any information that may be relevant, such as:
- Browser/Platform
- Theme
- Logs/Errors
validations:
required: true
- type: textarea
id: expected

- type: markdown
attributes:
label: What you expected to happen
placeholder: |
e.g. The post should appear.
validations:
required: true
- type: textarea
id: actual
value: |
<br>
## Impact
Please help us understand more about the impact of this issue to help determine next steps.
If you are unsure about anything, please use your judgment to make an educated guess.
- type: dropdown
id: impact
attributes:
label: What actually happened
placeholder: |
e.g. The post did not appear.
label: Site owner impact
description: Approximately what percentage of the total users of the platform are impacted? Unsure? Please provide your most educated guess!
options:
- Fewer than 20% of the total website/platform users
- Between 20% and 60% of the total website/platform users
- More than 60% of the total website/platform users
validations:
required: true
- type: dropdown
id: users-affected
id: severity
attributes:
label: Impact
description: Approximately how many users are impacted?
label: Severity
description: What is the severity of this issue? Please take a look at the descriptions below for further context.<br>
<br> - **Critical:** Prevents core functionality or has severe impact on the website/platform.
<br> - **Major:** Significantly impairs important features or has notable impact on the website/platform.
<br> - **Moderate:** Affects non-critical features or has limited impact on the website/platform.
<br> - **Minor:** Causes inconvenience or has minimal impact on functionality.
options:
- One
- Some (< 50%)
- Most (> 50%)
- All
- Critical
- Major
- Moderate
- Minor
validations:
required: true
- type: dropdown
id: workarounds
id: additional-impact
attributes:
label: Available workarounds?
label: What other impact(s) does this issue have?
description: You may select more than one
options:
- No and the platform is unusable
- No but the platform is still usable
- Yes, difficult to implement
- Yes, easy to implement
- There is no user impact
validations:
required: true
- Platform revenue
- Agency or developer revenue
- Individual site owner revenue
- No revenue impact
multiple: true

- type: markdown
attributes:
Expand All @@ -79,13 +94,12 @@ body:
## Optional Information
The following section is optional.
- type: textarea
id: logs
id: workaround
attributes:
label: Logs or notes
label: If a workaround is available, please outline it here.
placeholder: |
Add any information that may be relevant, such as:
- Browser/Platform
- Theme
- Logs/Errors
Provide details of the specific steps to take that resolve the issue, e.g.:
- Open "Setting X".
- Toggle "Option Y".
- Click "Button Z".
5 changes: 4 additions & 1 deletion .github/workflows/gardening.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,11 @@ jobs:
{"path": "src/reply", "label": "[Block] Federated reply"},
{"path": "src/reply-intent", "label": "[Block] Federated reply"},
{"path": "src/editor-plugin", "label": "[Block] Post settings"},
{"path": "src/reactions", "label": "[Block] Reactions"},
{"path": "src/reactions", "label": "[Feature] Reactions"},
{"path": "src", "label": "[Focus] Editor"},
{"path": "includes/class-blocks.php", "label": "[Focus] Editor"},
{"path": "integration", "label": "[Focus] Compatibility"},
{"path": "includes/collection", "label": "[Feature] Collections"}
{"path": "includes/collection", "label": "[Feature] Collections"},
{"path": "includes/class-mailer.php", "label": "[Feature] Notifications"}
]'

0 comments on commit 60f21f9

Please sign in to comment.