Skip to content

Commit 5cc1078

Browse files
mxschmittmxschmitt
authored
chore: new issue templates (#2277)
1 parent 0cfb23f commit 5cc1078

9 files changed

Lines changed: 275 additions & 101 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.md‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Bug Report 🪲
2+
description: Create a bug report to help us improve
3+
title: '[Bug]: '
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
# Please follow these steps first:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
## Troubleshoot
13+
If Playwright is not behaving the way you expect, we'd ask you to look at the [documentation](https://playwright.dev/python/docs/intro) and search the issue tracker for evidence supporting your expectation.
14+
Please make reasonable efforts to troubleshoot and rule out issues with your code, the configuration, or any 3rd party libraries you might be using.
15+
Playwright offers [several debugging tools](https://playwright.dev/python/docs/debug) that you can use to troubleshoot your issues.
16+
- type: markdown
17+
attributes:
18+
value: |
19+
## Ask for help through appropriate channels
20+
If you feel unsure about the cause of the problem, consider asking for help on for example [StackOverflow](https://stackoverflow.com/questions/ask) or our [Discord channel](https://aka.ms/playwright/discord) before posting a bug report. The issue tracker is not a help forum.
21+
- type: markdown
22+
attributes:
23+
value: |
24+
## Make a minimal reproduction
25+
To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the bug.
26+
The simpler you can make it, the more likely we are to successfully verify and fix the bug.
27+
- type: markdown
28+
attributes:
29+
value: |
30+
> [!IMPORTANT]
31+
> Bug reports without a minimal reproduction will be rejected.
32+
33+
---
34+
- type: input
35+
id: version
36+
attributes:
37+
label: Version
38+
description: |
39+
The version of Playwright you are using.
40+
Is it the [latest](https://github.com/microsoft/playwright-python/releases)? Test and see if the bug has already been fixed.
41+
placeholder: ex. 1.41.1
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: reproduction
46+
attributes:
47+
label: Steps to reproduce
48+
description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.
49+
value: |
50+
Example steps (replace with your own):
51+
1. Clone my repo at https://github.com/<myuser>/example
52+
2. pip install -r requirements.txt
53+
3. python test.py
54+
4. You should see the error come up
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: expected
59+
attributes:
60+
label: Expected behavior
61+
description: A description of what you expect to happen.
62+
placeholder: I expect to see X or Y
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: what-happened
67+
attributes:
68+
label: Actual behavior
69+
description: |
70+
A clear and concise description of the unexpected behavior.
71+
Please include any relevant output here, especially any error messages.
72+
placeholder: A bug happened!
73+
validations:
74+
required: true
75+
- type: textarea
76+
id: context
77+
attributes:
78+
label: Additional context
79+
description: Anything else that might be relevant
80+
validations:
81+
required: false
82+
- type: textarea
83+
id: envinfo
84+
attributes:
85+
label: Environment
86+
description: |
87+
Please provide information about the environment you are running in.
88+
value: |
89+
- Operating System: [Ubuntu 22.04]
90+
- CPU: [arm64]
91+
- Browser: [All, Chromium, Firefox, WebKit]
92+
- Python Version: [3.12]
93+
- Other info:
94+
render: Text
95+
validations:
96+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
blank_issues_enabled: false
12
contact_links:
23
- name: Join our Discord Server
34
url: https://aka.ms/playwright/discord

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation 📖
2+
description: Submit a request to add or update documentation
3+
title: '[Docs]: '
4+
labels: ['Documentation :book:']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### Thank you for helping us improve our documentation!
10+
Please be sure you are looking at [the Next version of the documentation](https://playwright.dev/python/docs/next/intro) before opening an issue here.
11+
- type: textarea
12+
id: links
13+
attributes:
14+
label: Page(s)
15+
description: |
16+
Links to one or more documentation pages that should be modified.
17+
If you are reporting an issue with a specific section of a page, try to link directly to the nearest anchor.
18+
If you are suggesting that a new page be created, link to the parent of the proposed page.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: description
23+
attributes:
24+
label: Description
25+
description: |
26+
Describe the change you are requesting.
27+
If the issue pertains to a single function or matcher, be sure to specify the entire call signature.
28+
validations:
29+
required: true

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature Request 🚀
2+
description: Submit a proposal for a new feature
3+
title: '[Feature]: '
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
### Thank you for taking the time to suggest a new feature!
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: '🚀 Feature Request'
13+
description: A clear and concise description of what the feature is.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: example
18+
attributes:
19+
label: Example
20+
description: Describe how this feature would be used.
21+
validations:
22+
required: false
23+
- type: textarea
24+
id: motivation
25+
attributes:
26+
label: Motivation
27+
description: |
28+
Outline your motivation for the proposal. How will it make Playwright better?
29+
validations:
30+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: 'Questions / Help 💬'
2+
description: If you have questions, please check StackOverflow or Discord
3+
title: '[Please read the message below]'
4+
labels: [':speech_balloon: Question']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Questions and Help 💬
10+
11+
This issue tracker is reserved for bug reports and feature requests.
12+
13+
For anything else, such as questions or getting help, please see:
14+
15+
- [The Playwright documentation](https://playwright.dev)
16+
- [Our Discord server](https://aka.ms/playwright/discord)
17+
- type: checkboxes
18+
id: no-post
19+
attributes:
20+
label: |
21+
Please do not submit this issue.
22+
description: |
23+
> [!IMPORTANT]
24+
> This issue will be closed.
25+
options:
26+
- label: I understand
27+
required: true

‎.github/ISSUE_TEMPLATE/regression.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/regression.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Report regression
2+
description: Functionality that used to work and does not any more
3+
title: "[Regression]: "
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
# Please follow these steps first:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
## Make a minimal reproduction
14+
To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the regression.
15+
The simpler you can make it, the more likely we are to successfully verify and fix the regression.
16+
- type: markdown
17+
attributes:
18+
value: |
19+
> [!IMPORTANT]
20+
> Regression reports without a minimal reproduction will be rejected.
21+
22+
---
23+
- type: input
24+
id: goodVersion
25+
attributes:
26+
label: Last Good Version
27+
description: |
28+
Last version of Playwright where the feature was working.
29+
placeholder: ex. 1.40.1
30+
validations:
31+
required: true
32+
- type: input
33+
id: badVersion
34+
attributes:
35+
label: First Bad Version
36+
description: |
37+
First version of Playwright where the feature was broken.
38+
Is it the [latest](https://github.com/microsoft/playwright-python/releases)? Test and see if the regression has already been fixed.
39+
placeholder: ex. 1.41.1
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: reproduction
44+
attributes:
45+
label: Steps to reproduce
46+
description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.
47+
value: |
48+
Example steps (replace with your own):
49+
1. Clone my repo at https://github.com/<myuser>/example
50+
2. pip -r requirements.txt
51+
3. python test.py
52+
4. You should see the error come up
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: expected
57+
attributes:
58+
label: Expected behavior
59+
description: A description of what you expect to happen.
60+
placeholder: I expect to see X or Y
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: what-happened
65+
attributes:
66+
label: Actual behavior
67+
description: A clear and concise description of the unexpected behavior.
68+
placeholder: A bug happened!
69+
validations:
70+
required: true
71+
- type: textarea
72+
id: context
73+
attributes:
74+
label: Additional context
75+
description: Anything else that might be relevant
76+
validations:
77+
required: false
78+
- type: textarea
79+
id: envinfo
80+
attributes:
81+
label: Environment
82+
description: |
83+
Please provide information about the environment you are running in.
84+
value: |
85+
- Operating System: [Ubuntu 22.04]
86+
- CPU: [arm64]
87+
- Browser: [All, Chromium, Firefox, WebKit]
88+
- Python Version: [3.12]
89+
- Other info:
90+
render: Text
91+
validations:
92+
required: true

0 commit comments

Comments
 (0)