From 4267060231d428f8ae3bfb817b4ada758faa010e Mon Sep 17 00:00:00 2001 From: Alex Rudenko Date: Wed, 23 Nov 2022 10:27:55 +0100 Subject: [PATCH] docs: add bug triage guidelines --- docs/contributing.md | 18 ++++++++++++++++++ docs/index.md | 7 +++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 417fb3b0513d8..7249cdb902fc3 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -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 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 and 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. +2. If the issue is specific to the headless headless, file an issue on crbug.com against the headless component. diff --git a/docs/index.md b/docs/index.md index 77662af70c835..bb32d151c8bb9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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` @@ -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