Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimal issue templates #91569

Merged
merged 18 commits into from
Apr 16, 2022
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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.
-->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
contact_links:
ezio-melotti marked this conversation as resolved.
Show resolved Hide resolved
- 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/"
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/crash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Crash report
about: A hard crash of the interpreter, possibly with a core dump
labels: "type-crash"
---

<!--
Do not submit this form if you encounter an exception being unexpectedly raised from a Python function.
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved
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).

**Traceback**

Enter the full traceback caused by the crash, if there is one.
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved

**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.
-->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Documentation
about: Report a problem with the documentation
labels: "docs"
---

**Documentation**

(A clear and concise description of the issue.)
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature
about: Submit a proposal for a new CPython feature
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved
labels: "type-feature"
---

**Feature**
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved

(A clear and concise description of your feature proposal.)
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved

**Pitch**

(Explain why this feature should be implemented and how it would be used. Add examples, if applicable.)
AlexWaygood marked this conversation as resolved.
Show resolved Hide resolved

**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.
-->
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/security.md
Original file line number Diff line number Diff line change
@@ -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.
-->