Skip to content

Commit

Permalink
Issue templates: update bug report template to match other repos (#8006)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeherve authored Aug 8, 2024
1 parent 1e693f7 commit c3c8bfa
Showing 1 changed file with 17 additions and 79 deletions.
96 changes: 17 additions & 79 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
name: Bug Report
description: Helps us improve our product!
labels: "Needs triage, [Type] Bug"
title: "[Bug]: "
description: Report issues with one of our products.
labels: [ 'Needs triage', '[Type] Bug' ]
body:
- type: markdown
attributes:
value: |
### Thanks for contributing!
Please write a clear title, then fill in as much details as possible.
Please write a clear title, then fill in the fields below and submit.
__Avoid using image hosting services such as Cloudup, Droplr, Imgur, etc., to link to media.__
Instead, attach screenshot(s) or recording(s) directly in any of the text areas below: click, then drag and drop.
Please **do not** link to image hosting services such as Cloudup, Droplr, Imgur, etc…
Instead, directly embed screenshot(s) or recording(s) in any of the text areas below: click, then drag and drop.
- type: markdown
attributes:
value: |
---
## Core Information
- type: textarea
id: summary
attributes:
Expand All @@ -25,95 +29,32 @@ body:
2. Click on any blog post.
3. Click on the 'Like' button.
4. ...
Attach any media by drag and dropping or selecting upload.
validations:
required: true
- type: textarea
id: expected
attributes:
label: What you expected to happen
label: A clear and concise description of what you expected to happen.
placeholder: |
e.g. The post should be liked.
validations:
required: true
eg. Post should be liked.
- type: textarea
id: actual
attributes:
label: What actually happened
placeholder: |
e.g. Clicking the button does nothing visibly.
validations:
required: true
- type: dropdown
id: browser
attributes:
label: Browser
description: (You may select more than one)
options:
- Google Chrome/Chromium
- Mozilla Firefox
- Microsoft Edge
- Apple Safari
- iOS Safari
- Android Chrome
multiple: true
- type: input
id: issue_context
attributes:
label: Context
placeholder: |
e.g. Customer report, details of your exploratory testing, etc.
- type: markdown
attributes:
value: |
---
## Additional context
The following section is optional. If you're an Automattician, you should be able to fill it in. If not, please scroll to the bottom and submit the issue.
- type: dropdown
id: site-type
attributes:
label: Platform (Simple, Atomic, or both?)
description: (You may select more than one)
options:
- Simple
- Atomic
- Self-hosted
multiple: true
- type: textarea
id: other_notes
attributes:
label: Other notes
placeholder: |
e.g. Logs, CLI or console errors, notes, observations, etc.
- type: markdown
attributes:
value: |
---
## Issue severity
Please provide details around how often the issue is reproducible & how many users are affected.
- type: dropdown
id: reproducibility
attributes:
label: Reproducibility
options:
- Consistent
- Intermittent
- Once
validations:
required: true
eg. Clicking the button does nothing visibly.
- type: dropdown
id: users-affected
attributes:
label: Severity
description: How many users are impacted? A guess is fine.
label: Impact
description: Approximately how many users are impacted?
options:
- One
- Some (< 50%)
- Most (> 50%)
- All
validations:
required: true
- type: dropdown
id: workarounds
attributes:
Expand All @@ -126,12 +67,10 @@ body:
- There is no user impact
validations:
required: true

- type: markdown
attributes:
value: |
<br>
- type: textarea
id: workaround-detail
attributes:
Expand All @@ -141,7 +80,6 @@ body:
- Open "Setting X".
- Toggle "Option Y".
- Click "Button Z".
- type: markdown
attributes:
value: |
Expand Down

0 comments on commit c3c8bfa

Please sign in to comment.