Skip to content

Commit

Permalink
Convert the GitHub issue templates into issue forms
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexWaygood committed Aug 13, 2023
1 parent 9b75ada commit 10cbf0f
Show file tree
Hide file tree
Showing 6 changed files with 171 additions and 148 deletions.
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Bug report
description: Submit a bug report
labels: ["type-bug"]
body:
- type: markdown
attributes:
value: |
New to Python? The issue tracker isn't the right place to get help.
Consider instead:
- reading the [Python tutorial](https://docs.python.org/3/tutorial/)
- posting on [Discourse](https://discuss.python.org/c/users/7)
- emailing [python-list](https://mail.python.org/mailman/listinfo/python-list)
- type: checkboxes
attributes:
label: Checklist
description: Bugs in third-party projects (e.g. `requests`) do not belong in the CPython issue tracker
options:
- label: I am confident this is a bug in CPython, not a bug in a third-party project
required: true
- label: |
I have searched the [CPython issue tracker](https://github.com/python/cpython/issues),
and am confident this bug has not been reported before
required: true
- 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.
placeholder: |
```py
your code here
```
validations:
required: true
- 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: textarea
attributes:
label: Operating system and architecture tested on
validations:
required: false
- type: textarea
attributes:
label: Any other relevant information
validations:
required: false
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/crash.md

This file was deleted.

59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/crash.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
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.
Exceptions unexpectedly raised from stdlib Python functions
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: 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.
placeholder: |
```py
your code here
```
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
validations:
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: textarea
attributes:
label: Operating system and architecture tested on
validations:
required: false
- type: textarea
attributes:
label: Any other relevant information
validations:
required: false
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature or enhancement
description: Submit a proposal for a new CPython feature or enhancement
labels: ["type-feature"]
body:
- type: dropdown
attributes:
label: Has this already been discussed elsewhere?
description: |
Proposing a new feature for Python?
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.
multiple: false
options:
- I have already discussed this feature proposal on Discourse
- This is a minor feature, which does not need previous discussion elsewhere
validations:
required: true
- type: textarea
attributes:
label: Links to previous discussion of this feature
validations:
required: false
- type: textarea
attributes:
label: Summary of proposal
description: A clear and concise 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:
```py
your code here
```
validations:
required: true

0 comments on commit 10cbf0f

Please sign in to comment.