Skip to content

infra: update templates to new form style, add config links #2571

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 5 commits into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
119 changes: 119 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
name: "Bug Report"
description: Report a bug with pyton.org website to help us improve
title: "Bug: <title>"
labels: ["bug", "Triage Required"]

body:
- type: markdown
attributes:
value: |
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).

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
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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCS.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: "Documentation Update"
description: Create an issue for documentation changes
title: "Docs: <title>"
labels: ["documentation"]

body:
- type: markdown
attributes:
value: |
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).

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:
label: "Summary"
description: Provide a brief summary of your request
placeholder: We need to update the documentation to include information about...
validations:
required: true
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: "Feature Request"
description: Suggest an idea for www.pyton.org
title: "Enhancement: <title>"
labels: ["enhancement"]

body:
- type: markdown
attributes:
value: |
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).

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
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
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.