Skip to content

Commit

Permalink
Add new Issue template for bug reports
Browse files Browse the repository at this point in the history
  • Loading branch information
jeherve committed Jul 15, 2022
1 parent a3e523d commit 2718f40
Showing 1 changed file with 133 additions and 0 deletions.
133 changes: 133 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
name: Bug Report
description: Helps us improve our product!
labels: "Needs triage, [Type] Bug"
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
### Thanks for contributing!
Please write a clear title, then fill in as much details as possible.
__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.
- type: textarea
id: summary
attributes:
label: Quick summary
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1. Start at `site-domain.com/blog`.
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
placeholder: |
e.g. The post should be liked.
validations:
required: true
- 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
- type: dropdown
id: users-affected
attributes:
label: Severity
description: How many users are impacted? A guess is fine.
options:
- One
- Some (< 50%)
- Most (> 50%)
- All
- type: dropdown
id: workarounds
attributes:
label: Available workarounds?
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
- type: textarea
id: workarounds-detail
attributes:
label: Workaround details
description: If you are aware of a workaround, please describe it below.
placeholder: |
e.g. There is an alternative way to access this setting in the sidebar, but it's not readily apparent.

0 comments on commit 2718f40

Please sign in to comment.