Improve the GitHub issue forms (#108881)

This commit is contained in:
Alex Waygood 2023-09-05 09:01:30 +01:00 committed by GitHub
parent 5a2a046151
commit 24e989211a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 44 additions and 75 deletions

View file

@ -9,20 +9,26 @@ body:
For help or advice on using Python, try one of the following options instead of opening a GitHub issue: For help or advice on using Python, try one of the following options instead of opening a GitHub issue:
- Posting on [Discourse](https://discuss.python.org/c/users/7) - Asking on [Discourse](https://discuss.python.org/c/users/7) or [Stack Overflow](https://stackoverflow.com)
- Reading the [Python tutorial](https://docs.python.org/3/tutorial/) - Reading the [Python tutorial](https://docs.python.org/3/tutorial/)
- Emailing [python-list](https://mail.python.org/mailman/listinfo/python-list) - Emailing [python-list](https://mail.python.org/mailman/listinfo/python-list)
- type: checkboxes
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.
- type: textarea
attributes: attributes:
label: Checklist label: "Bug description:"
description: A bug in a third-party project (for example, `pip` or `requests`) should be reported to that project's issue tracker, not CPython description: >
options: Give a clear and concise description of what happened.
- label: I am confident this is a bug in CPython, not a bug in a third-party project Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
required: false [Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016),
- label: | and put any code blocks inside triple backticks.
I have searched the [CPython issue tracker](https://github.com/python/cpython/issues?q=is%3Aissue+sort%3Acreated-desc),
and am confident this bug has not been reported before value: |
required: false ```python
# Add a code block here, if required
```
validations:
required: true
- type: dropdown - type: dropdown
attributes: attributes:
label: "CPython versions tested on:" label: "CPython versions tested on:"
@ -47,23 +53,3 @@ body:
- Other - Other
validations: validations:
required: false required: false
- type: input
attributes:
label: "Output from running 'python -VV' on the command line:"
description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description.
validations:
required: false
- type: textarea
attributes:
label: "A clear and concise description of the bug:"
description: >
Tell us what happened.
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
Put any code blocks inside triple backticks.
value: |
```python
# Add a code block here, if required
```
validations:
required: true

View file

@ -8,6 +8,20 @@ body:
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. 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.
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. 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.
- type: textarea
attributes:
label: What happened?
description: >
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
[Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016),
and put any code blocks inside triple backticks.
value: |
```python
# Add a code block here, if required
```
validations:
required: true
- type: dropdown - type: dropdown
attributes: attributes:
label: "CPython versions tested on:" label: "CPython versions tested on:"
@ -38,34 +52,3 @@ body:
description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description. description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description.
validations: validations:
required: false required: false
- type: textarea
attributes:
label: What happened?
description: >
Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible.
Put any code blocks inside triple backticks.
value: |
```python
# Add a code block here, if required
```
validations:
required: true
- type: textarea
attributes:
label: Error messages
description: >
Enter any error messages caused by the crash, including a core dump if there is one.
Feel free to leave this bit blank if it isn't relevant.
placeholder: |
Error messages should be formatted like this:
<details>
<summary>Error messages/core dump</summary>
```
# paste errors here, if you have any
```
</details>
validations:
required: false

View file

@ -10,6 +10,19 @@ body:
You'll need to demonstrate widespread support for your idea among the community. You'll need to demonstrate widespread support for your idea among the community.
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. 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.
- type: textarea
attributes:
label: "Proposal:"
description: >
Explain your proposal, why it should be implemented, and how it would be used.
Add examples, if applicable.
Put any code blocks inside triple backticks.
value: |
```python
# Add a code block here, if required
```
validations:
required: true
- type: dropdown - type: dropdown
attributes: attributes:
label: Has this already been discussed elsewhere? label: Has this already been discussed elsewhere?
@ -25,16 +38,3 @@ body:
label: "Links to previous discussion of this feature:" label: "Links to previous discussion of this feature:"
validations: validations:
required: false required: false
- type: textarea
attributes:
label: "Proposal:"
description: >
Explain your proposal, why it should be implemented, and how it would be used.
Add examples, if applicable.
Put any code blocks inside triple backticks.
value: |
```python
# Add a code block here, if required
```
validations:
required: true