chore: update bug template (#9477)

See internal doc.
This commit is contained in:
jrandolf 2023-01-10 11:35:53 +01:00 committed by GitHub
parent 8f99a79ee4
commit 7620cb30c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,66 +5,111 @@ labels: [bug]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: >
### Thanks for taking the time to fill out this bug report! ### 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
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:
1. … **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 expectation
description: What do you expect to happen? What actually happened instead?
placeholder: |
I expected ...
What happened instead was ...
validations: validations:
required: true required: true
- type: input - id: behavior
id: puppeteer-version type: checkboxes
attributes:
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
- id: error
type: input
attributes:
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
- 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: attributes:
label: Puppeteer version label: Puppeteer version
description: What version of Puppeteer are you running? description: |
What version of Puppeteer are you running? *This must be a valid semver
tag.*
validations: validations:
required: true required: true
- type: input - id: node-version
id: node-version type: input
attributes: attributes:
label: Node.js version label: Node version
description: What version of Node.js are you running? description: |
What supported version of Node.js are you running? *This must be a valid
semver tag.*
validations: validations:
required: true required: true
- type: input - id: pkg-mgr
id: npm-version type: dropdown
attributes: attributes:
label: npm version label: Package manager
description: What version of npm are you running? description: What package manager are you running?
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What operating system are you seeing the problem on?
multiple: true
options: options:
- Linux - npm
- macOS - yarn
- Windows - pnpm
validations: validations:
required: true required: true
- type: textarea - id: pkg-mgr-version
id: config type: input
attributes: attributes:
label: Configuration file label: Package manager version
description: | description: |
Please copy and paste your configuration file [[Docs](https://pptr.dev/guides/configuration/)]. What version of the package manager are you running? *This must be a
*No need for backticks — this automatically gets formatted into code.* valid semver tag.*
render: JavaScript validations:
- type: textarea required: true
id: logs - id: operating-system
type: dropdown
attributes: attributes:
label: Relevant log output label: Operating system
description: | description: What supported operating system are you running?
Please copy and paste any relevant log output. options:
*No need for backticks — this automatically gets formatted into code.* - Windows
render: Shell - macOS
- Linux
validations:
required: true