Skip to content

Commit 1169b0b

Browse files
AlexWaygoodhugovkezio-melottiErlend Egeberg Aasland
authored
Add minimal issue templates (#91569)
* Add minimal issue templates * Wording tweaks * Apply suggestions from code review Co-authored-by: Hugo van Kemenade <[email protected]> * Improve words in `security` template * Update bug.md * Update crash.md * Add link to security vulnerability website from first page * Never edit on your phone * Apply suggestions from code review Co-authored-by: Hugo van Kemenade <[email protected]> * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Hugo van Kemenade <[email protected]> * Apply suggestions from code review Co-authored-by: Hugo van Kemenade <[email protected]> * Apply suggestions from code review Co-authored-by: Ezio Melotti <[email protected]> Co-authored-by: Erlend Egeberg Aasland <[email protected]> * There might not be a traceback if there's a crash Co-authored-by: Ezio Melotti <[email protected]> * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Ezio Melotti <[email protected]> * Reorder `config.yml` file * Fix Erlend's nits * version -> architecture * Apply suggestions from code review Co-authored-by: Ezio Melotti <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Ezio Melotti <[email protected]> Co-authored-by: Erlend Egeberg Aasland <[email protected]>
1 parent c4e8a93 commit 1169b0b

File tree

6 files changed

+137
-0
lines changed

6 files changed

+137
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Submit a bug report
4+
labels: "type-bug"
5+
---
6+
7+
<!--
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:
10+
11+
- 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
16+
-->
17+
18+
**Bug report**
19+
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.
22+
23+
**Your environment**
24+
25+
<!-- Include as many relevant details as possible about the environment you experienced the bug in -->
26+
27+
- CPython versions tested on:
28+
- Operating system and architecture:
29+
30+
<!--
31+
You can freely edit this text. Remove any lines you believe are unnecessary.
32+
-->

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
contact_links:
2+
- name: "Getting help"
3+
about: "Ask questions about using Python and debugging errors on Discourse."
4+
url: "https://discuss.python.org/c/users/7"
5+
- name: "Proposing new features"
6+
about: "Submit major feature proposal (e.g. syntax changes) to an ideas forum first."
7+
url: "https://discuss.python.org/c/ideas/6"
8+
- name: "Reporting security vulnerabilities"
9+
about: "See here for details on reporting security vulnerabilities in CPython"
10+
url: "https://www.python.org/dev/security/"

‎.github/ISSUE_TEMPLATE/crash.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Crash report
3+
about: A hard crash of the interpreter, possibly with a core dump
4+
labels: "type-crash"
5+
---
6+
7+
<!--
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.
11+
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.
14+
-->
15+
16+
**Crash report**
17+
18+
Tell us what happened, ideally including a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example).
19+
20+
**Error messages**
21+
22+
Enter any relevant error message caused by the crash, including a core dump if there is one.
23+
24+
**Your environment**
25+
26+
<!-- Include as many relevant details as possible about the environment you experienced the bug in -->
27+
28+
- CPython versions tested on:
29+
- Operating system and architecture:
30+
31+
<!--
32+
You can freely edit this text. Remove any lines you believe are unnecessary.
33+
-->

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Documentation
3+
about: Report a problem with the documentation
4+
labels: "docs"
5+
---
6+
7+
**Documentation**
8+
9+
(A clear and concise description of the issue.)

‎.github/ISSUE_TEMPLATE/feature.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature or enhancement
3+
about: Submit a proposal for a new CPython feature or enhancement
4+
labels: "type-feature"
5+
---
6+
7+
**Feature or enhancement**
8+
9+
(A clear and concise description of your proposal.)
10+
11+
**Pitch**
12+
13+
(Explain why this feature or enhacement should be implemented and how it would be used.
14+
Add examples, if applicable.)
15+
16+
**Previous discussion**
17+
18+
<!--
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:
23+
-->
24+
25+
26+
<!--
27+
You can freely edit this text. Remove any lines you believe are unnecessary.
28+
-->

‎.github/ISSUE_TEMPLATE/security.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Security vulnerability report
3+
about: Submit a report regarding a security vulnerability
4+
labels: "type-security"
5+
---
6+
7+
<!--
8+
Note that security issues should generally first be sent to the "security at python dot org" email address.
9+
See here for further details: https://www.python.org/dev/security/
10+
-->
11+
12+
**Security vulnerability report**
13+
14+
A description of what the security vulnerability is.
15+
16+
**Your environment**
17+
18+
<!-- Include as many relevant details about your environment as possible -->
19+
20+
- CPython versions tested on:
21+
- Operating system and architecture:
22+
23+
<!--
24+
You can freely edit this text. Remove any lines you believe are unnecessary.
25+
-->

0 commit comments

Comments
 (0)