Skip to content

Commit

Permalink
chore: update bug template (#9477)
Browse files Browse the repository at this point in the history
See internal doc.
  • Loading branch information
jrandolf committed Jan 10, 2023
1 parent 8f99a79 commit 7620cb3
Showing 1 changed file with 87 additions and 42 deletions.
129 changes: 87 additions & 42 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,66 +5,111 @@ labels: [bug]
body:
- type: markdown
attributes:
value: |
value: >
### Thanks for taking the time to fill out this bug report!
**Before filling out this report**, please check our [Troubleshooting](https://pptr.dev/troubleshooting) guide for solutions to common issues.
Also, verify the problem is *related to packages maintained by Puppeteer* (this does not include `puppeteer-extra`, `expect-puppeteer`, etc.).
- type: textarea
id: summary
**Before filling out this report**, please check our
[Troubleshooting](https://pptr.dev/troubleshooting) guide for solutions
to common issues.
- id: summary
type: textarea
attributes:
label: Bug description
description: What did you do? What did you expect to happen? What actually happened instead? Provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
value: |
Steps to reproduce the problem:
label: Bug expectation
description: What do you expect to happen? What actually happened instead?
placeholder: |
I expected ...
1. …
What happened instead was ...
validations:
required: true
- type: input
id: puppeteer-version
- id: behavior
type: checkboxes
attributes:
label: Puppeteer version
description: What version of Puppeteer are you running?
label: Bug behavior
description: >
How does the bug behave? Does it happen very rarely (flaky)? Is there a
lack of error (no error)? If there is a PDF problem, make sure the
script writes the PDF somewhere in the current working directory. *Note:
PDF implies no error.*
options:
- label: Flaky
- label: No error
- label: PDF
- id: mvce
type: textarea
attributes:
label: Minimal, reproducible example
description: >
Provide a [minimal, reproducible
example](https://stackoverflow.com/help/minimal-reproducible-example).
*No need for backticks — this automatically gets formatted into code.*
render: TypeScript
validations:
required: true
- type: input
id: node-version
- id: error
type: input
attributes:
label: Node.js version
description: What version of Node.js are you running?
label: Error string
description: >
Provide the bug's error. For example, `throw new Error('test')` would
have the error `test`. *Do not include the entire error log.*
validations:
required: true
- type: input
id: npm-version
- id: puppeteer-configuration
type: textarea
attributes:
label: Puppeteer configuration
description: >
Copy and paste your [configuration
file](https://pptr.dev/guides/configuration/) (if applicable). *No need
for backticks — this automatically gets formatted into code.*
render: TypeScript
- id: puppeteer-version
type: input
attributes:
label: npm version
description: What version of npm are you running?
label: Puppeteer version
description: |
What version of Puppeteer are you running? *This must be a valid semver
tag.*
validations:
required: true
- id: node-version
type: input
attributes:
label: Node version
description: |
What supported version of Node.js are you running? *This must be a valid
semver tag.*
validations:
required: true
- type: dropdown
id: operating-system
- id: pkg-mgr
type: dropdown
attributes:
label: What operating system are you seeing the problem on?
multiple: true
label: Package manager
description: What package manager are you running?
options:
- Linux
- macOS
- Windows
- npm
- yarn
- pnpm
validations:
required: true
- type: textarea
id: config
- id: pkg-mgr-version
type: input
attributes:
label: Configuration file
label: Package manager version
description: |
Please copy and paste your configuration file [[Docs](https://pptr.dev/guides/configuration/)].
*No need for backticks — this automatically gets formatted into code.*
render: JavaScript
- type: textarea
id: logs
What version of the package manager are you running? *This must be a
valid semver tag.*
validations:
required: true
- id: operating-system
type: dropdown
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
*No need for backticks — this automatically gets formatted into code.*
render: Shell
label: Operating system
description: What supported operating system are you running?
options:
- Windows
- macOS
- Linux
validations:
required: true

0 comments on commit 7620cb3

Please sign in to comment.