From 445eec3aa4d319ac10f869c67a8ac6945f5a6ebe Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Wed, 25 Sep 2024 21:04:54 -0500 Subject: [PATCH 1/9] infra: use new github issue forms --- .github/ISSUE_TEMPLATE/bug_report.md | 25 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 47 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ---------- .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++++++++++ 4 files changed, 86 insertions(+), 47 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 78aa34d6bb..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -> Note: This repo is for the Python devguide. If you are requesting an -enhancement for the Python language or CPython interpreter, -then the CPython issue tracker is better -suited for this report: https://github.com/python/cpython/issues - -**Describe the bug** -A clear and concise description of what the bug is. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..7de791a619 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,47 @@ +name: "Bug report" +description: Create a report to help us improve the Python devguide +title: "Bug: " +labels: ["bug"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + > [!NOTE] + > This repo is for the Python devguide. If you are reporting a bug + > for the Python language or CPython interpreter, + > then the CPython issue tracker is better + > suited for this report: https://github.com/python/cpython/issues + + - type: textarea + id: bug_description + attributes: + label: "Describe the bug" + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: "Expected behavior" + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional context" + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index eff8cb8f7a..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -> Note: This repo is for the Python devguide. If you are requesting an -enhancement for the Python language or CPython interpreter, -then the CPython issue tracker is better -suited for this report: https://github.com/python/cpython/issues - -**Describe the enhancement or feature you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..8323cb8777 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: "Feature request" +description: Suggest an idea for the Python devguide +title: "Feature: <title>" +labels: ["enhancement"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + > [!NOTE] + > This repo is for the Python devguide. If you are requesting an + > enhancement for the Python language or CPython interpreter, + > then the CPython issue tracker is better + > suited for this report: https://github.com/python/cpython/issues + + - type: textarea + id: feature_description + attributes: + label: "Describe the enhancement or feature you'd like" + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives you've considered" + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional context" + description: Add any other context or screenshots about the feature request here. + validations: + required: false From 3aafd71a2088841998111cef12fcbc8adae799aa Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Thu, 26 Sep 2024 11:18:44 -0500 Subject: [PATCH 2/9] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7de791a619..e11852dead 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,10 +9,10 @@ body: attributes: value: | > [!NOTE] - > This repo is for the Python devguide. If you are reporting a bug - > for the Python language or CPython interpreter, - > then the CPython issue tracker is better - > suited for this report: https://github.com/python/cpython/issues + > This repo is for the [Python devguide](https://devguide.python.org/). + > If you are reporting a bug for the Python language or + > CPython interpreter, then use the + > [CPython issue tracker](https://github.com/python/cpython/issues) instead. - type: textarea id: bug_description From 7a3c2b3485e01aa0a63485c6638f2a872e0f4e9f Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Thu, 26 Sep 2024 11:18:52 -0500 Subject: [PATCH 3/9] Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> --- .github/ISSUE_TEMPLATE/feature_request.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 8323cb8777..daa6035f99 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -9,10 +9,10 @@ body: attributes: value: | > [!NOTE] - > This repo is for the Python devguide. If you are requesting an - > enhancement for the Python language or CPython interpreter, - > then the CPython issue tracker is better - > suited for this report: https://github.com/python/cpython/issues + > This repo is for the [Python devguide](https://devguide.python.org/). + > If you are requesting an enhancement for the Python language or + > CPython interpreter, then use the + > [CPython issue tracker](https://github.com/python/cpython/issues) instead. - type: textarea id: feature_description From 1f6cc181379ead1d0787efb852e02c3940975d0d Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Thu, 26 Sep 2024 11:19:00 -0500 Subject: [PATCH 4/9] Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> --- .github/ISSUE_TEMPLATE/feature_request.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index daa6035f99..e95eb316b0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -25,8 +25,8 @@ body: - type: textarea id: alternatives attributes: - label: "Describe alternatives you've considered" - description: A clear and concise description of any alternative solutions or features you've considered. + label: "Describe alternatives you have considered" + description: A clear and concise description of any alternative solutions or features you have considered. validations: required: false From 7d4ec0eb37b2d64003b00c83db898808fbfdf2d5 Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Thu, 26 Sep 2024 11:19:07 -0500 Subject: [PATCH 5/9] Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e95eb316b0..585cbf7a8f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -17,7 +17,7 @@ body: - type: textarea id: feature_description attributes: - label: "Describe the enhancement or feature you'd like" + label: "Describe the enhancement or feature you would like" description: A clear and concise description of what you want to happen. validations: required: true From 9f9faa653ad0cdeea2e3b9fa6fe5dc11860a17a3 Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Tue, 8 Oct 2024 15:06:35 -0500 Subject: [PATCH 6/9] infra: add quicklinks --- .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..cd8c31d2a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: CPython Documentation + url: https://docs.python.org/ + about: Official CPython documentation - please check here before opening an issue. + - name: Python Website + url: https://python.org/ + about: For all things Python + - name: PyPI Issues / Support + url: https://github.com/pypi/support + about: For issues with PyPI itself, PyPI accounts, or with packages hosted on PyPI. + - name: CPython Issues + url: https://github.com/python/cpython/issues + about: For issues with the CPython interpreter itself. From c634d1eee3c7593682a6aff497fa3c257571ec00 Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Tue, 8 Oct 2024 15:07:33 -0500 Subject: [PATCH 7/9] chore: address review --- .github/ISSUE_TEMPLATE/bug_report.yml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e11852dead..2816489626 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -18,15 +18,7 @@ body: id: bug_description attributes: label: "Describe the bug" - description: A clear and concise description of what the bug is. - validations: - required: true - - - type: textarea - id: expected_behavior - attributes: - label: "Expected behavior" - description: A clear and concise description of what you expected to happen. + description: A clear and concise description of what the bug is and, optionally, what you expected to happen. validations: required: true From 61732c0211b324682098311cdb0515bece1a651e Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Thu, 10 Oct 2024 09:31:06 -0500 Subject: [PATCH 8/9] Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 585cbf7a8f..a4413c137a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -9,7 +9,7 @@ body: attributes: value: | > [!NOTE] - > This repo is for the [Python devguide](https://devguide.python.org/). + > This repo is for the [Python developer's guide](https://devguide.python.org/). > If you are requesting an enhancement for the Python language or > CPython interpreter, then use the > [CPython issue tracker](https://github.com/python/cpython/issues) instead. From 1cf3edffe06ba664a95b67ba391c60c8486973a5 Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Thu, 10 Oct 2024 09:31:11 -0500 Subject: [PATCH 9/9] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2816489626..b160c6ea11 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,7 +9,7 @@ body: attributes: value: | > [!NOTE] - > This repo is for the [Python devguide](https://devguide.python.org/). + > This repo is for the [Python developer's guide](https://devguide.python.org/). > If you are reporting a bug for the Python language or > CPython interpreter, then use the > [CPython issue tracker](https://github.com/python/cpython/issues) instead.