diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 05f4f317ccc..21a375361bf 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -9,20 +9,26 @@ body: For help or advice on using Python, try one of the following options instead of opening a GitHub issue: - - Posting on [Discourse](https://discuss.python.org/c/users/7) + - Asking on [Discourse](https://discuss.python.org/c/users/7) or [Stack Overflow](https://stackoverflow.com) - Reading the [Python tutorial](https://docs.python.org/3/tutorial/) - Emailing [python-list](https://mail.python.org/mailman/listinfo/python-list) - - type: checkboxes + + Make sure to also search the [CPython issue tracker](https://github.com/python/cpython/issues?q=is%3Aissue+sort%3Acreated-desc) to check that the bug has not already been reported. + - type: textarea attributes: - label: Checklist - description: A bug in a third-party project (for example, `pip` or `requests`) should be reported to that project's issue tracker, not CPython - options: - - label: I am confident this is a bug in CPython, not a bug in a third-party project - required: false - - label: | - I have searched the [CPython issue tracker](https://github.com/python/cpython/issues?q=is%3Aissue+sort%3Acreated-desc), - and am confident this bug has not been reported before - required: false + label: "Bug description:" + description: > + Give a clear and concise description of what happened. + Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible. + [Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016), + and put any code blocks inside triple backticks. + + value: | + ```python + # Add a code block here, if required + ``` + validations: + required: true - type: dropdown attributes: label: "CPython versions tested on:" @@ -47,23 +53,3 @@ body: - Other validations: required: false - - type: input - attributes: - label: "Output from running 'python -VV' on the command line:" - description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description. - validations: - required: false - - type: textarea - attributes: - label: "A clear and concise description of the bug:" - description: > - Tell us what happened. - Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible. - Put any code blocks inside triple backticks. - - value: | - ```python - # Add a code block here, if required - ``` - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml index 1ea84b89369..c14d7cf2599 100644 --- a/.github/ISSUE_TEMPLATE/crash.yml +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -8,6 +8,20 @@ body: This form is for hard crashes of the Python interpreter, segmentation faults, failed C-level assertions, and similar. Unexpected exceptions raised from Python functions in the standard library count as bugs rather than crashes. 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. + - type: textarea + attributes: + label: What happened? + description: > + Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible. + [Copy and paste code where possible rather than using screenshots](https://meta.stackoverflow.com/a/285557/13990016), + and put any code blocks inside triple backticks. + + value: | + ```python + # Add a code block here, if required + ``` + validations: + required: true - type: dropdown attributes: label: "CPython versions tested on:" @@ -38,34 +52,3 @@ body: description: If you tested with multiple operating systems or architectures, feel free to provide details in the main bug description. validations: required: false - - type: textarea - attributes: - label: What happened? - description: > - Include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible. - Put any code blocks inside triple backticks. - - value: | - ```python - # Add a code block here, if required - ``` - validations: - required: true - - type: textarea - attributes: - label: Error messages - description: > - Enter any error messages caused by the crash, including a core dump if there is one. - Feel free to leave this bit blank if it isn't relevant. - placeholder: | - Error messages should be formatted like this: - -
- Error messages/core dump - - ``` - # paste errors here, if you have any - ``` -
- validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 0200e623d2a..4361ab2bf82 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -10,6 +10,19 @@ body: You'll need to demonstrate widespread support for your idea among the community. Major feature proposals should generally be discussed on [Discourse](https://discuss.python.org/c/ideas/6) before opening a GitHub issue. Wait until it's clear that most people support your idea before filling in this form. + - type: textarea + attributes: + label: "Proposal:" + description: > + Explain your proposal, why it should be implemented, and how it would be used. + Add examples, if applicable. + Put any code blocks inside triple backticks. + value: | + ```python + # Add a code block here, if required + ``` + validations: + required: true - type: dropdown attributes: label: Has this already been discussed elsewhere? @@ -25,16 +38,3 @@ body: label: "Links to previous discussion of this feature:" validations: required: false - - type: textarea - attributes: - label: "Proposal:" - description: > - Explain your proposal, why it should be implemented, and how it would be used. - Add examples, if applicable. - Put any code blocks inside triple backticks. - value: | - ```python - # Add a code block here, if required - ``` - validations: - required: true