From 242b43e0a11c1c3c29e80691bdb3376e1c8f7984 Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Mon, 16 Sep 2024 17:04:20 -0500 Subject: [PATCH 1/4] infra: update templates to new form style, add config links --- .github/ISSUE_TEMPLATE/BUG.yml | 121 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/DOCS.yml | 14 +++ .github/ISSUE_TEMPLATE/REQUEST.yml | 68 ++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 45 -------- .github/ISSUE_TEMPLATE/config.yml | 14 +++ .github/ISSUE_TEMPLATE/feature_request.md | 27 ----- 6 files changed, 217 insertions(+), 72 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG.yml create mode 100644 .github/ISSUE_TEMPLATE/DOCS.yml create mode 100644 .github/ISSUE_TEMPLATE/REQUEST.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml new file mode 100644 index 000000000..ea12b3250 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -0,0 +1,121 @@ +name: "Bug Report" +description: Report a bug with Python.org website to help us improve +title: "Bug: " +labels: ["Bug", "Triage Required"] + +body: + - type: markdown + attributes: + value: | + This is the repository and issue tracker for https://www.python.org website. + + If you're looking to file an issue with CPython itself, please go to + https://github.com/python/cpython/issues/new/choose + + Issues related to Python's documentation (https://docs.python.org) can + also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md. + + - type: textarea + id: description + attributes: + label: "Describe the bug" + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: "To Reproduce" + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: "Expected behavior" + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: input + id: reprod-url + attributes: + label: "URL to the issue" + description: Please enter the URL to provide a reproduction of the issue, if applicable + placeholder: ex. https://python.org/my-issue/here + validations: + required: false + + - type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + value: | + "![SCREENSHOT_DESCRIPTION](SCREENSHOT_LINK.png)" + render: bash + validations: + required: false + + - type: dropdown + id: browsers + attributes: + label: "Browsers" + description: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Other + validations: + required: true + + - type: dropdown + id: os + attributes: + label: "Operating System" + description: What operating system are you using? + options: + - Windows + - macOS + - Linux + - iOS + - Android + - Other + validations: + required: true + + - type: input + id: version + attributes: + label: "Browser Version" + description: What version of the browser are you using? + placeholder: "e.g. 22" + validations: + required: false + + - type: textarea + id: logs + attributes: + label: "Relevant log output" + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + + - type: textarea + id: additional + attributes: + label: "Additional context" + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/DOCS.yml b/.github/ISSUE_TEMPLATE/DOCS.yml new file mode 100644 index 000000000..ef49aa804 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DOCS.yml @@ -0,0 +1,14 @@ +name: "Documentation Update" +description: Create an issue for documentation changes +title: "Docs: <title>" +labels: ["Documentation"] + +body: + - type: textarea + id: summary + attributes: + label: "Summary" + description: Provide a brief summary of your request + placeholder: We need to update the documentation to include information about... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/REQUEST.yml b/.github/ISSUE_TEMPLATE/REQUEST.yml new file mode 100644 index 000000000..6633c2cb2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/REQUEST.yml @@ -0,0 +1,68 @@ +name: "Feature Request" +description: Suggest an idea for www.python.org +title: "Enhancement: <title>" +labels: ["Enhancement"] + +body: + - type: markdown + attributes: + value: | + This is the repository and issue tracker for https://www.python.org website. + + If you're looking to file an issue with CPython itself, please go to + https://github.com/python/cpython/issues/new/choose + + Issues related to Python's documentation (https://docs.python.org) can + also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md. + + - type: textarea + id: problem + attributes: + label: "Is your feature request related to a problem? Please describe." + description: A clear and concise description of what the problem is. + placeholder: Ex. I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: solution + attributes: + label: "Describe the solution you'd like" + description: A clear and concise description of what you want to happen. + placeholder: Ex. It would be great if [...] + validations: + required: true + + - type: textarea + id: basic_example + attributes: + label: "Basic Example" + description: Provide some basic examples of your feature request. + placeholder: Describe how your feature would work with a simple example. + validations: + required: false + + - 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: drawbacks + attributes: + label: "Drawbacks and Impact" + description: What are the drawbacks or impacts of your feature request? + placeholder: Describe any potential drawbacks or impacts of implementing this feature. + 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c958c11a4..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Bug report -about: Report a bug with Python.org website to help us improve ---- - -<!-- -This is the repository and issue tracker for https://www.python.org -website. - -If you're looking to file an issue with CPython itself, please go to -https://github.com/python/cpython/issues/new/choose - -Issues related to Python's documentation (https://docs.python.org) can -also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md. ---> - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..cd8c31d2a --- /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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 514274e5f..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for www.python.org ---- - -<!-- -This is the repository and issue tracker for https://www.python.org -website. - -If you're looking to file an issue with CPython itself, please go to -https://github.com/python/cpython/issues/new/choose - -Issues related to Python's documentation (https://docs.python.org) can -also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md. ---> - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. Ex. It would be great if [...] - -**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. From dc692bc3639066da9b64db0ede2a203d7a4ac762 Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Mon, 16 Sep 2024 17:16:49 -0500 Subject: [PATCH 2/4] fix: update links --- .github/ISSUE_TEMPLATE/BUG.yml | 10 ++++------ .github/ISSUE_TEMPLATE/DOCS.yml | 11 ++++++++++- .github/ISSUE_TEMPLATE/REQUEST.yml | 12 +++++------- 3 files changed, 19 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index ea12b3250..5b1df7628 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -1,19 +1,17 @@ name: "Bug Report" description: Report a bug with Python.org website to help us improve title: "Bug: <title>" -labels: ["Bug", "Triage Required"] +labels: ["bug", "Triage Required"] body: - type: markdown attributes: value: | - This is the repository and issue tracker for https://www.python.org website. + This is the repository and issue tracker for the https://www.Python.org website. - If you're looking to file an issue with CPython itself, please go to - https://github.com/python/cpython/issues/new/choose + If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose). - Issues related to Python's documentation (https://docs.python.org) can - also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md. + Issues related to [Python's documentation](https://docs.python.org) can also be filed [here](https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md). - type: textarea id: description diff --git a/.github/ISSUE_TEMPLATE/DOCS.yml b/.github/ISSUE_TEMPLATE/DOCS.yml index ef49aa804..371057824 100644 --- a/.github/ISSUE_TEMPLATE/DOCS.yml +++ b/.github/ISSUE_TEMPLATE/DOCS.yml @@ -1,9 +1,18 @@ name: "Documentation Update" description: Create an issue for documentation changes title: "Docs: <title>" -labels: ["Documentation"] +labels: ["documentation"] body: + - type: markdown + attributes: + value: | + This is the repository and issue tracker for the https://www.Python.org website. + + If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose). + + Issues related to [Python's documentation](https://docs.python.org) can also be filed [here](https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md). + - type: textarea id: summary attributes: diff --git a/.github/ISSUE_TEMPLATE/REQUEST.yml b/.github/ISSUE_TEMPLATE/REQUEST.yml index 6633c2cb2..ca3d8e251 100644 --- a/.github/ISSUE_TEMPLATE/REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/REQUEST.yml @@ -1,19 +1,17 @@ name: "Feature Request" description: Suggest an idea for www.python.org title: "Enhancement: <title>" -labels: ["Enhancement"] +labels: ["enhancement"] body: - type: markdown attributes: value: | - This is the repository and issue tracker for https://www.python.org website. + This is the repository and issue tracker for the https://www.Python.org website. - If you're looking to file an issue with CPython itself, please go to - https://github.com/python/cpython/issues/new/choose + If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose). - Issues related to Python's documentation (https://docs.python.org) can - also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md. + Issues related to [Python's documentation](https://docs.python.org) can also be filed [here](https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md). - type: textarea id: problem @@ -42,7 +40,7 @@ body: validations: required: false - - type: textarea + - type: textarea id: alternatives attributes: label: "Describe alternatives you've considered" From 303e5da83f479e7677341ff231d28f525ee3b5aa Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Mon, 16 Sep 2024 17:19:25 -0500 Subject: [PATCH 3/4] chore: casing --- .github/ISSUE_TEMPLATE/REQUEST.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/REQUEST.yml b/.github/ISSUE_TEMPLATE/REQUEST.yml index ca3d8e251..f6a6b9a03 100644 --- a/.github/ISSUE_TEMPLATE/REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/REQUEST.yml @@ -1,5 +1,5 @@ name: "Feature Request" -description: Suggest an idea for www.python.org +description: Suggest an idea for www.Python.org title: "Enhancement: <title>" labels: ["enhancement"] From 8d37207fcd84374e509bf919da0d223ff5b0d334 Mon Sep 17 00:00:00 2001 From: Jacob Coffee <jacob@z7x.org> Date: Wed, 18 Sep 2024 13:24:02 -0500 Subject: [PATCH 4/4] chore: no caps! --- .github/ISSUE_TEMPLATE/BUG.yml | 4 ++-- .github/ISSUE_TEMPLATE/DOCS.yml | 2 +- .github/ISSUE_TEMPLATE/REQUEST.yml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index 5b1df7628..9adc2b03a 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -1,5 +1,5 @@ name: "Bug Report" -description: Report a bug with Python.org website to help us improve +description: Report a bug with pyton.org website to help us improve title: "Bug: <title>" labels: ["bug", "Triage Required"] @@ -7,7 +7,7 @@ body: - type: markdown attributes: value: | - This is the repository and issue tracker for the https://www.Python.org website. + This is the repository and issue tracker for the https://www.pyton.org website. If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose). diff --git a/.github/ISSUE_TEMPLATE/DOCS.yml b/.github/ISSUE_TEMPLATE/DOCS.yml index 371057824..df7a2c231 100644 --- a/.github/ISSUE_TEMPLATE/DOCS.yml +++ b/.github/ISSUE_TEMPLATE/DOCS.yml @@ -7,7 +7,7 @@ body: - type: markdown attributes: value: | - This is the repository and issue tracker for the https://www.Python.org website. + This is the repository and issue tracker for the https://www.pyton.org website. If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose). diff --git a/.github/ISSUE_TEMPLATE/REQUEST.yml b/.github/ISSUE_TEMPLATE/REQUEST.yml index f6a6b9a03..144ad75c1 100644 --- a/.github/ISSUE_TEMPLATE/REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/REQUEST.yml @@ -1,5 +1,5 @@ name: "Feature Request" -description: Suggest an idea for www.Python.org +description: Suggest an idea for www.pyton.org title: "Enhancement: <title>" labels: ["enhancement"] @@ -7,7 +7,7 @@ body: - type: markdown attributes: value: | - This is the repository and issue tracker for the https://www.Python.org website. + This is the repository and issue tracker for the https://www.pyton.org website. If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose).