Skip to content

Commit bfb7999

Browse files
authored
docs: issue guide (#34457)
1 parent 039f513 commit bfb7999

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

FILING_ISSUES.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# How to File a Bug Report That Actually Gets Resolved
2+
3+
Make sure you’re on the latest Playwright release before filing. Check existing GitHub issues to avoid duplicates.
4+
5+
## Use the Template
6+
7+
Follow the **Bug Report** template. It guides you step-by-step:
8+
9+
- Fill it out thoroughly.
10+
- Clearly list the steps needed to reproduce the bug.
11+
- Provide what you expected to see versus what happened in reality.
12+
- Include system info from `npx envinfo --preset playwright`.
13+
14+
## Keep Your Repro Minimal
15+
16+
We can't parse your entire code base. Reduce it down to the absolute essentials:
17+
18+
- Start a fresh project (`npm init playwright@latest new-project`).
19+
- Add only the code/DOM needed to show the problem.
20+
- Only use major frameworks if necessary (React, Angular, static HTTP server, etc.).
21+
- Avoid adding extra libraries unless absolutely necessary. Note that we won't install any suspect dependencies.
22+
23+
## Why This Matters
24+
- Most issues that lack a repro turn out to be misconfigurations or usage errors.
25+
- We can't fix problems if we can’t reproduce them ourselves.
26+
- We can’t debug entire private projects or handle sensitive credentials.
27+
- Each confirmed bug will have a test in our repo, so your repro must be as clean as possible.
28+
29+
## More Help
30+
31+
- [Stack Overflow’s Minimal Reproducible Example Guide](https://stackoverflow.com/help/minimal-reproducible-example)
32+
- [Playwright Debugging Tools](https://playwright.dev/docs/debug)
33+
34+
## Bottom Line
35+
A well-isolated bug speeds up verification and resolution. Minimal, public repro or it’s unlikely we can assist.

0 commit comments

Comments
 (0)