summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/crash.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE/crash.md')
-rw-r--r--.github/ISSUE_TEMPLATE/crash.md33
1 files changed, 24 insertions, 9 deletions
diff --git a/.github/ISSUE_TEMPLATE/crash.md b/.github/ISSUE_TEMPLATE/crash.md
index dad3423..a268249 100644
--- a/.github/ISSUE_TEMPLATE/crash.md
+++ b/.github/ISSUE_TEMPLATE/crash.md
@@ -5,29 +5,44 @@ labels: "type-crash"
---
<!--
- 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.
-->