Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert the GitHub issue templates into GitHub issue forms #107920

Merged
merged 26 commits into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ae77c74
Convert the GitHub issue templates into GitHub issue forms
AlexWaygood Aug 13, 2023
02ccad5
Apply suggestions from code review
AlexWaygood Aug 13, 2023
fe0525b
Update .github/ISSUE_TEMPLATE/bug.yml
AlexWaygood Aug 13, 2023
cce5d12
Apply suggestions from code review
AlexWaygood Aug 13, 2023
2c81d51
More feedback
AlexWaygood Aug 13, 2023
3853e1e
Update .github/ISSUE_TEMPLATE/bug.yml
AlexWaygood Aug 13, 2023
b96f5ef
More improvements to the crash report form
AlexWaygood Aug 13, 2023
55733cb
Apply suggestions from code review
AlexWaygood Aug 13, 2023
503004a
Improve version dropdown options
AlexWaygood Aug 13, 2023
020e2a6
More improvements to crash report
AlexWaygood Aug 13, 2023
0a85030
Delete the 'any other information?' boxes
AlexWaygood Aug 13, 2023
cc8ddf5
Try to make the bug report less condescending
AlexWaygood Aug 13, 2023
58d43d2
.
AlexWaygood Aug 13, 2023
79fb56e
More feedback from Ezio
AlexWaygood Aug 13, 2023
02c2d22
Fix syntax
AlexWaygood Aug 13, 2023
36fa3f0
no Latin in my issue form please
AlexWaygood Aug 13, 2023
376845d
Colons
AlexWaygood Aug 13, 2023
02c0a46
YAML
AlexWaygood Aug 13, 2023
257d353
Apply suggestions from code review
AlexWaygood Aug 13, 2023
f1a0519
smol
AlexWaygood Aug 13, 2023
a58a7fd
Update .github/ISSUE_TEMPLATE/crash.yml
AlexWaygood Aug 13, 2023
5b8d990
Don't require the bug report checkboxes
AlexWaygood Aug 13, 2023
775339b
Tidy up newlines
AlexWaygood Aug 13, 2023
305bfa8
Update .github/ISSUE_TEMPLATE/feature.yml
AlexWaygood Aug 13, 2023
5ad5344
Update .github/ISSUE_TEMPLATE/bug.yml
AlexWaygood Aug 14, 2023
08dc736
Switch back to 'CPython main branch'
AlexWaygood Aug 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug report
description: Submit a bug report
labels: ["type-bug"]
body:
- type: markdown
attributes:
value: |
**New to Python?**

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)
- Reading the [Python tutorial](https://docs.python.org/3/tutorial/)
- Emailing [python-list](https://mail.python.org/mailman/listinfo/python-list)
- type: checkboxes
attributes:
label: Checklist
description: A bug in a third-party project (for example, `pip` or `requests`) should be reported to that project's issue tracker, not CPython
options:
- label: I am confident this is a bug in CPython, not a bug in a third-party project
required: false
- label: |
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
required: false
- type: dropdown
attributes:
label: "CPython versions tested on:"
multiple: true
options:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
- "CPython main branch"
validations:
required: true
- type: dropdown
attributes:
label: "Operating systems tested on:"
multiple: true
options:
- Linux
- macOS
- Windows
- Other
validations:
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
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/crash.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/crash.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Crash report
description: A hard crash of the interpreter, possibly with a core dump
labels: ["type-crash"]
body:
- type: markdown
attributes:
value: |
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.
- type: dropdown
attributes:
label: "CPython versions tested on:"
multiple: true
options:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
- "CPython main branch"
validations:
required: true
- type: dropdown
attributes:
label: "Operating systems tested on:"
multiple: true
options:
- Linux
- macOS
- Windows
- Other
validations:
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: 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
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature or enhancement
description: Submit a proposal for a new CPython feature or enhancement
labels: ["type-feature"]
body:
- type: markdown
attributes:
value: |
# Proposing a feature to CPython?

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.
- type: checkboxes
attributes:
label: Has this already been discussed elsewhere?
options:
- label: I have already discussed this feature proposal on Discourse
- label: This is a minor feature, which does not need previous discussion elsewhere
- type: textarea
attributes:
label: "Links to previous discussion of this feature:"
validations:
required: false
- type: input
attributes:
label: "Summary of proposal:"
description: A one-line summary of your proposal.
validations:
required: true
- type: textarea
attributes:
label: "Pitch:"
description: >
Explain why this feature or enhancement 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