-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
Add minimal issue templates #91569
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
Merged
Merged
Add minimal issue templates #91569
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
16d59f5
Add minimal issue templates
AlexWaygood de9ed90
Wording tweaks
AlexWaygood 483632e
Apply suggestions from code review
AlexWaygood 5afdd72
Improve words in `security` template
AlexWaygood b289c49
Update bug.md
AlexWaygood d4eccad
Update crash.md
AlexWaygood 0664d48
Add link to security vulnerability website from first page
AlexWaygood 22ef781
Never edit on your phone
AlexWaygood a9aea8f
Apply suggestions from code review
AlexWaygood fa7da16
Update .github/ISSUE_TEMPLATE/config.yml
AlexWaygood 246ea0a
Apply suggestions from code review
AlexWaygood 2a50b24
Apply suggestions from code review
AlexWaygood 642bc82
There might not be a traceback if there's a crash
AlexWaygood 4f11634
Update .github/ISSUE_TEMPLATE/config.yml
AlexWaygood 1834c5c
Reorder `config.yml` file
AlexWaygood 9c96ec7
Fix Erlend's nits
AlexWaygood 6afef34
version -> architecture
AlexWaygood 534c607
Apply suggestions from code review
AlexWaygood File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
--> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/" | ||
AlexWaygood marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
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). | ||
|
||
**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. | ||
--> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
--> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
--> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.