Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit d0dcd27

Browse filesBrowse files
AlexWaygoodezio-melotti
AlexWaygood
and
ezio-melotti
authored
Improve the GitHub issue templates (#107150)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
1 parent 87de2fb commit d0dcd27
Copy full SHA for d0dcd27

File tree

Expand file treeCollapse file tree

3 files changed

+84
-27
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+84
-27
lines changed

‎.github/ISSUE_TEMPLATE/bug.md

Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug.md
+30-10Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,48 @@ labels: "type-bug"
55
---
66

77
<!--
8-
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
9-
the right place to seek help. Consider the following options instead:
8+
New to Python? The issue tracker isn't the right place to get help.
9+
Consider instead:
1010
1111
- reading the Python tutorial: https://docs.python.org/3/tutorial/
12-
- posting in the "Users" category on discuss.python.org: https://discuss.python.org/c/users/7
13-
- emailing the Python-list mailing list: https://mail.python.org/mailman/listinfo/python-list
14-
- searching our issue tracker (https://github.com/python/cpython/issues) to see if
15-
your problem has already been reported
12+
- posting at https://discuss.python.org/c/users/7
13+
- emailing https://mail.python.org/mailman/listinfo/python-list
1614
-->
1715

1816
# Bug report
1917

20-
A clear and concise description of what the bug is.
21-
Include a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example), if possible.
18+
## Checklist
19+
20+
<!-- Bugs in third-party projects (e.g. `requests`) do not belong in the CPython issue tracker -->
21+
22+
- [ ] I am confident this is a bug in CPython,
23+
not a bug in a third-party project
24+
- [ ] I have searched the CPython issue tracker,
25+
and am confident this bug has not been reported before
26+
27+
## A clear and concise description of the bug
28+
29+
<!--
30+
Include a minimal, reproducible example if possible.
31+
(https://stackoverflow.com/help/minimal-reproducible-example)
32+
33+
Put any code blocks inside triple backticks:
34+
35+
```py
36+
your code here
37+
```
38+
39+
-->
40+
41+
2242

2343
# Your environment
2444

25-
<!-- Include as many relevant details as possible about the environment you experienced the bug in -->
45+
<!-- Include all relevant details about the environment you experienced the bug in -->
2646

2747
- CPython versions tested on:
2848
- Operating system and architecture:
2949

3050
<!--
31-
You can freely edit this text. Remove any lines you believe are unnecessary.
51+
You can freely edit this form. Remove any lines you believe are unnecessary.
3252
-->

‎.github/ISSUE_TEMPLATE/crash.md

Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/crash.md
+24-9Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,44 @@ labels: "type-crash"
55
---
66

77
<!--
8-
Use this template for hard crashes of the interpreter, segmentation faults, failed C-level assertions, and similar.
9-
Do not submit this form if you encounter an exception being unexpectedly raised from a Python function.
10-
Most of the time, these should be filed as bugs, rather than crashes.
8+
This form is for hard crashes of the Python interpreter, segmentation faults,
9+
failed C-level assertions, and similar.
10+
Exceptions unexpectedly raised from stdlib Python functions
11+
count as bugs rather than crashes.
1112
12-
The CPython interpreter is itself written in a different programming language, C.
13-
For CPython, a "crash" is when Python itself fails, leading to a traceback in the C stack.
13+
The CPython interpreter is written in a different programming language, C.
14+
A "CPython crash" is when Python itself fails, leading to a traceback in the C stack.
1415
-->
1516

1617
# Crash report
1718

18-
Tell us what happened, ideally including a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example).
19+
<!--
20+
Tell us what happened. Ideally, include a minimal, reproducible example.
21+
(https://stackoverflow.com/help/minimal-reproducible-example)
22+
23+
Put any code blocks inside triple backticks:
24+
25+
```py
26+
your code here
27+
```
28+
29+
-->
30+
31+
1932

2033
# Error messages
2134

22-
Enter any relevant error message caused by the crash, including a core dump if there is one.
35+
<!-- Enter any error messages caused by the crash, including a core dump if there is one -->
36+
37+
2338

2439
# Your environment
2540

26-
<!-- Include as many relevant details as possible about the environment you experienced the bug in -->
41+
<!-- Include all relevant details about the environment you experienced the crash in -->
2742

2843
- CPython versions tested on:
2944
- Operating system and architecture:
3045

3146
<!--
32-
You can freely edit this text. Remove any lines you believe are unnecessary.
47+
You can freely edit this form. Remove any lines you believe are unnecessary.
3348
-->

‎.github/ISSUE_TEMPLATE/feature.md

Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature.md
+30-8Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,47 @@ about: Submit a proposal for a new CPython feature or enhancement
44
labels: "type-feature"
55
---
66

7+
<!--
8+
Proposing a new feature for Python?
9+
You'll need to demonstrate widespread support for your idea among the community.
10+
11+
Major feature proposals should generally be discussed at
12+
https://discuss.python.org/c/ideas/6 before opening a GitHub issue.
13+
Wait until it's clear that most people support your idea
14+
before filling in this form.
15+
-->
16+
717
# Feature or enhancement
818

9-
(A clear and concise description of your proposal.)
19+
<!-- A clear and concise description of your proposal. -->
20+
21+
1022

1123
# Pitch
1224

13-
(Explain why this feature or enhancement should be implemented and how it would be used.
14-
Add examples, if applicable.)
25+
<!--
26+
Explain why this feature or enhancement should be implemented and how it would be used.
27+
Add examples, if applicable.
28+
29+
Put any code blocks inside triple backticks:
30+
31+
```py
32+
your code here
33+
```
34+
35+
-->
36+
37+
1538

1639
# Previous discussion
1740

1841
<!--
19-
New features to Python should first be discussed elsewhere before creating issues on GitHub,
20-
for example in the "ideas" category (https://discuss.python.org/c/ideas/6) of discuss.python.org,
21-
or the python-ideas mailing list (https://mail.python.org/mailman3/lists/python-ideas.python.org/).
22-
Use this space to post links to the places where you have already discussed this feature proposal:
42+
Use this space to post links to the places
43+
where you have already discussed your feature proposal:
2344
-->
2445

2546

47+
2648
<!--
27-
You can freely edit this text. Remove any lines you believe are unnecessary.
49+
You can freely edit this form. Remove any lines you believe are unnecessary.
2850
-->

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.