Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-02-28 18:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve the GitHub issue templates (#107150)

Browse source 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
This commit is contained in:
Alex Waygood 2023-07-29 15:42:44 +01:00 • committed by GitHub
parent 87de2fbb1e
commit d0dcd27d3a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 84 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

40
.github/ISSUE_TEMPLATE/bug.md vendored
View file

@ -5,28 +5,48 @@
---
<!--
If you're new to Python and you're not sure whether what you're experiencing is a bug, the CPython issue tracker is not
the right place to seek help. Consider the following options instead:
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 in the "Users" category on discuss.python.org: https://discuss.python.org/c/users/7
- emailing the Python-list mailing list: https://mail.python.org/mailman/listinfo/python-list
- searching our issue tracker (https://github.com/python/cpython/issues) to see if
your problem has already been reported
- posting at https://discuss.python.org/c/users/7
- emailing https://mail.python.org/mailman/listinfo/python-list
-->
# Bug report
A clear and concise description of what the bug is.
Include a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example), if possible.
## Checklist
<!-- Bugs in third-party projects (e.g. `requests`) do not belong in the CPython issue tracker -->
- [ ] I am confident this is a bug in CPython,
not a bug in a third-party project
- [ ] I have searched the CPython issue tracker,
and am confident this bug has not been reported before
## A clear and concise description of the bug
<!--
Include a minimal, reproducible example if possible.
(https://stackoverflow.com/help/minimal-reproducible-example)
Put any code blocks inside triple backticks:
```py
your code here
```
-->
# Your environment
<!-- Include as many relevant details as possible about the environment you experienced the bug in -->
<!-- Include all relevant details about the environment you experienced the bug in -->
- CPython versions tested on:
- Operating system and architecture:
<!--
You can freely edit this text. Remove any lines you believe are unnecessary.
You can freely edit this form. Remove any lines you believe are unnecessary.
-->

33
.github/ISSUE_TEMPLATE/crash.md vendored
View file

@ -5,29 +5,44 @@
---
<!--
Use this template for hard crashes of the interpreter, segmentation faults, failed C-level assertions, and similar.
Do not submit this form if you encounter an exception being unexpectedly raised from a Python function.
Most of the time, these should be filed as bugs, rather than crashes.
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 itself written in a different programming language, C.
For CPython, a "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.
-->
# Crash report
Tell us what happened, ideally including a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example).
<!--
Tell us what happened. Ideally, include a minimal, reproducible example.
(https://stackoverflow.com/help/minimal-reproducible-example)
Put any code blocks inside triple backticks:
```py
your code here
```
-->
# Error messages
Enter any relevant error message caused by the crash, including a core dump if there is one.
<!-- Enter any error messages caused by the crash, including a core dump if there is one -->
# Your environment
<!-- Include as many relevant details as possible about the environment you experienced the bug in -->
<!-- Include all relevant details about the environment you experienced the crash in -->
- CPython versions tested on:
- Operating system and architecture:
<!--
You can freely edit this text. Remove any lines you believe are unnecessary.
You can freely edit this form. Remove any lines you believe are unnecessary.
-->

38
.github/ISSUE_TEMPLATE/feature.md vendored
View file

@ -4,25 +4,47 @@
labels: "type-feature"
---
<!--
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 at
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.
-->
# Feature or enhancement
(A clear and concise description of your proposal.)
<!-- A clear and concise description of your proposal. -->
# Pitch
(Explain why this feature or enhancement should be implemented and how it would be used.
Add examples, if applicable.)
<!--
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
```
-->
# Previous discussion
<!--
New features to Python should first be discussed elsewhere before creating issues on GitHub,
for example in the "ideas" category (https://discuss.python.org/c/ideas/6) of discuss.python.org,
or the python-ideas mailing list (https://mail.python.org/mailman3/lists/python-ideas.python.org/).
Use this space to post links to the places where you have already discussed this feature proposal:
Use this space to post links to the places
where you have already discussed your feature proposal:
-->
<!--
You can freely edit this text. Remove any lines you believe are unnecessary.
You can freely edit this form. Remove any lines you believe are unnecessary.
-->