Skip to content

Commit 24e9892

Browse files
authored
Improve the GitHub issue forms (#108881)
1 parent 5a2a046 commit 24e9892

File tree

3 files changed

+44
-75
lines changed

3 files changed

+44
-75
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,26 @@ body:
99
1010
For help or advice on using Python, try one of the following options instead of opening a GitHub issue:
1111
12-
- Posting on [Discourse](https://discuss.python.org/c/users/7)
12+
- Asking on [Discourse](https://discuss.python.org/c/users/7) or [Stack Overflow](https://stackoverflow.com)
1313
- Reading the [Python tutorial](https://docs.python.org/3/tutorial/)
1414
- Emailing [python-list](https://mail.python.org/mailman/listinfo/python-list)
15-
- type: checkboxes
15+
16+
Make sure to also search the [CPython issue tracker](https://github.com/python/cpython/issues?q=is%3Aissue+sort%3Acreated-desc) to check that the bug has not already been reported.
17+
- type: textarea
1618
attributes:
17-
label: Checklist
18-
description: A bug in a third-party project (for example, `pip` or `requests`) should be reported to that project's issue tracker, not CPython
19-
options:
20-
- label: I am confident this is a bug in CPython, not a bug in a third-party project
21-
required: false
22-
- label: |
23-
I have searched the [CPython issue tracker](https://github.com/python/cpython/issues?q=is%3Aissue+sort%3Acreated-desc),
24-
and am confident this bug has not been reported before
25-
required: false
19+
label: "Bug description:"
20+
description: >
21+
Give a clear and concise description of what happened.
22+
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
23+
[Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016),
24+
and put any code blocks inside triple backticks.
25+
26+
value: |
27+
```python
28+
# Add a code block here, if required
29+
```
30+
validations:
31+
required: true
2632
- type: dropdown
2733
attributes:
2834
label: "CPython versions tested on:"
@@ -47,23 +53,3 @@ body:
4753
- Other
4854
validations:
4955
required: false
50-
- type: input
51-
attributes:
52-
label: "Output from running 'python -VV' on the command line:"
53-
description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description.
54-
validations:
55-
required: false
56-
- type: textarea
57-
attributes:
58-
label: "A clear and concise description of the bug:"
59-
description: >
60-
Tell us what happened.
61-
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
62-
Put any code blocks inside triple backticks.
63-
64-
value: |
65-
```python
66-
# Add a code block here, if required
67-
```
68-
validations:
69-
required: true

.github/ISSUE_TEMPLATE/crash.yml

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ body:
88
This form is for hard crashes of the Python interpreter, segmentation faults, failed C-level assertions, and similar. Unexpected exceptions raised from Python functions in the standard library count as bugs rather than crashes.
99
1010
The CPython interpreter is written in a different programming language, C. A "CPython crash" is when Python itself fails, leading to a traceback in the C stack.
11+
- type: textarea
12+
attributes:
13+
label: What happened?
14+
description: >
15+
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
16+
[Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016),
17+
and put any code blocks inside triple backticks.
18+
19+
value: |
20+
```python
21+
# Add a code block here, if required
22+
```
23+
validations:
24+
required: true
1125
- type: dropdown
1226
attributes:
1327
label: "CPython versions tested on:"
@@ -38,34 +52,3 @@ body:
3852
description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description.
3953
validations:
4054
required: false
41-
- type: textarea
42-
attributes:
43-
label: What happened?
44-
description: >
45-
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
46-
Put any code blocks inside triple backticks.
47-
48-
value: |
49-
```python
50-
# Add a code block here, if required
51-
```
52-
validations:
53-
required: true
54-
- type: textarea
55-
attributes:
56-
label: Error messages
57-
description: >
58-
Enter any error messages caused by the crash, including a core dump if there is one.
59-
Feel free to leave this bit blank if it isn't relevant.
60-
placeholder: |
61-
Error messages should be formatted like this:
62-
63-
<details>
64-
<summary>Error messages/core dump</summary>
65-
66-
```
67-
# paste errors here, if you have any
68-
```
69-
</details>
70-
validations:
71-
required: false

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ body:
1010
You'll need to demonstrate widespread support for your idea among the community.
1111
1212
Major feature proposals should generally be discussed on [Discourse](https://discuss.python.org/c/ideas/6) before opening a GitHub issue. Wait until it's clear that most people support your idea before filling in this form.
13+
- type: textarea
14+
attributes:
15+
label: "Proposal:"
16+
description: >
17+
Explain your proposal, why it should be implemented, and how it would be used.
18+
Add examples, if applicable.
19+
Put any code blocks inside triple backticks.
20+
value: |
21+
```python
22+
# Add a code block here, if required
23+
```
24+
validations:
25+
required: true
1326
- type: dropdown
1427
attributes:
1528
label: Has this already been discussed elsewhere?
@@ -25,16 +38,3 @@ body:
2538
label: "Links to previous discussion of this feature:"
2639
validations:
2740
required: false
28-
- type: textarea
29-
attributes:
30-
label: "Proposal:"
31-
description: >
32-
Explain your proposal, why it should be implemented, and how it would be used.
33-
Add examples, if applicable.
34-
Put any code blocks inside triple backticks.
35-
value: |
36-
```python
37-
# Add a code block here, if required
38-
```
39-
validations:
40-
required: true

0 commit comments

Comments
 (0)