Skip to content

Commit

Permalink
docs: add bug triage guidelines (#9305)
Browse files Browse the repository at this point in the history
Co-authored-by: Mathias Bynens <mathias@qiwi.be>
  • Loading branch information
OrKoN and mathiasbynens committed Nov 23, 2022
1 parent bef1061 commit eda1827
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
18 changes: 18 additions & 0 deletions docs/contributing.md
Expand Up @@ -322,3 +322,21 @@ In the event release-please fails, the following needs to be done:

2. Create a GitHub release for each package, following the practice of previous
releases.

## Bug triage guidelines

[Check incoming bug reports](https://github.com/puppeteer/puppeteer/issues) that do not have a `confirmed` or `needs-feedback` label:

1. Make sure the issue is labeled as either `bug` or `feature`.
2. If the issue does not have a clear repro or you cannot repro, ask for the repro and set the `needs-feedback` label.
3. Follow-up on the issues you previously asked for a feedback on (you should get a notification on GitHub when the user responds).
4. If the user does not provide feedback, the issue will be closed by the stale bot eventually.
5. If you are able to reproduce the issue, add the label `confirmed`.
6. If the bug is on the Chromium side, create a corresponding crbug.com issue, label the GitHub issue with the `upstream` label, and post a link to crbug.com in the comments.
7. If the issue is not related to either Puppeteer or Chromium, close the issue.
8. If the issue is about missing/incorrect documentation, label it as `documentation`.

Issues with PDFs:

1. If the issue reproduces using the regular print dialog and/or headful, [file a crbug.com against the `Blink>Layout` component](https://bugs.chromium.org/p/chromium/issues/entry?components=Blink%3ELayout).
2. If the issue is specific to Headless mode, [file an issue on crbug.com against the `Internals>Headless` component](https://bugs.chromium.org/p/chromium/issues/entry?components=Internals%3EHeadless).
7 changes: 3 additions & 4 deletions docs/index.md
Expand Up @@ -73,7 +73,7 @@ module.exports = {
After adding the configuration file, you will need to remove and reinstall
`puppeteer` for it to take effect.

See [Configuring Puppeteer](https://pptr.dev/guides/configuration) for more
See the [configuration guide](https://pptr.dev/guides/configuration) for more
information.

#### `puppeteer-core`
Expand Down Expand Up @@ -209,12 +209,11 @@ run**.

#### Using Docker

See our [guide on using Docker](https://pptr.dev/guides/docker).
See our [Docker guide](https://pptr.dev/guides/docker).

#### Using Chrome Extensions

See our
[guide on using Chrome extensions](https://pptr.dev/guides/chrome-extensions).
See our [Chrome extensions guide](https://pptr.dev/guides/chrome-extensions).

## Resources

Expand Down

0 comments on commit eda1827

Please sign in to comment.