mirror of https://github.com/python/cpython
Add minimal issue templates (#91569)
* Add minimal issue templates * Wording tweaks * Apply suggestions from code review Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * 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 <hugovk@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no> * There might not be a traceback if there's a crash Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Reorder `config.yml` file * Fix Erlend's nits * version -> architecture * Apply suggestions from code review Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
This commit is contained in:
parent
c4e8a93eb3
commit
1169b0b3ca
|
@ -0,0 +1,32 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Submit a bug report
|
||||||
|
labels: "type-bug"
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
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:
|
||||||
|
|
||||||
|
- 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
|
||||||
|
-->
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
**Your environment**
|
||||||
|
|
||||||
|
<!-- Include as many relevant details as possible 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.
|
||||||
|
-->
|
|
@ -0,0 +1,10 @@
|
||||||
|
contact_links:
|
||||||
|
- name: "Getting help"
|
||||||
|
about: "Ask questions about using Python and debugging errors on Discourse."
|
||||||
|
url: "https://discuss.python.org/c/users/7"
|
||||||
|
- name: "Proposing new features"
|
||||||
|
about: "Submit major feature proposal (e.g. syntax changes) to an ideas forum first."
|
||||||
|
url: "https://discuss.python.org/c/ideas/6"
|
||||||
|
- name: "Reporting security vulnerabilities"
|
||||||
|
about: "See here for details on reporting security vulnerabilities in CPython"
|
||||||
|
url: "https://www.python.org/dev/security/"
|
|
@ -0,0 +1,33 @@
|
||||||
|
---
|
||||||
|
name: Crash report
|
||||||
|
about: A hard crash of the interpreter, possibly with a core dump
|
||||||
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
**Crash report**
|
||||||
|
|
||||||
|
Tell us what happened, ideally including a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example).
|
||||||
|
|
||||||
|
**Error messages**
|
||||||
|
|
||||||
|
Enter any relevant error message 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 -->
|
||||||
|
|
||||||
|
- CPython versions tested on:
|
||||||
|
- Operating system and architecture:
|
||||||
|
|
||||||
|
<!--
|
||||||
|
You can freely edit this text. Remove any lines you believe are unnecessary.
|
||||||
|
-->
|
|
@ -0,0 +1,9 @@
|
||||||
|
---
|
||||||
|
name: Documentation
|
||||||
|
about: Report a problem with the documentation
|
||||||
|
labels: "docs"
|
||||||
|
---
|
||||||
|
|
||||||
|
**Documentation**
|
||||||
|
|
||||||
|
(A clear and concise description of the issue.)
|
|
@ -0,0 +1,28 @@
|
||||||
|
---
|
||||||
|
name: Feature or enhancement
|
||||||
|
about: Submit a proposal for a new CPython feature or enhancement
|
||||||
|
labels: "type-feature"
|
||||||
|
---
|
||||||
|
|
||||||
|
**Feature or enhancement**
|
||||||
|
|
||||||
|
(A clear and concise description of your proposal.)
|
||||||
|
|
||||||
|
**Pitch**
|
||||||
|
|
||||||
|
(Explain why this feature or enhacement should be implemented and how it would be used.
|
||||||
|
Add examples, if applicable.)
|
||||||
|
|
||||||
|
**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:
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
You can freely edit this text. Remove any lines you believe are unnecessary.
|
||||||
|
-->
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
name: Security vulnerability report
|
||||||
|
about: Submit a report regarding a security vulnerability
|
||||||
|
labels: "type-security"
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Note that security issues should generally first be sent to the "security at python dot org" email address.
|
||||||
|
See here for further details: https://www.python.org/dev/security/
|
||||||
|
-->
|
||||||
|
|
||||||
|
**Security vulnerability report**
|
||||||
|
|
||||||
|
A description of what the security vulnerability is.
|
||||||
|
|
||||||
|
**Your environment**
|
||||||
|
|
||||||
|
<!-- Include as many relevant details about your environment as possible -->
|
||||||
|
|
||||||
|
- CPython versions tested on:
|
||||||
|
- Operating system and architecture:
|
||||||
|
|
||||||
|
<!--
|
||||||
|
You can freely edit this text. Remove any lines you believe are unnecessary.
|
||||||
|
-->
|
Loading…
Reference in New Issue