Skip to content

Commit 242b43e

Browse files
JacobCoffeeJacobCoffee
committed
infra: update templates to new form style, add config links
1 parent 097df08 commit 242b43e

File tree

6 files changed

+217
-72
lines changed

6 files changed

+217
-72
lines changed

‎.github/ISSUE_TEMPLATE/BUG.yml

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: "Bug Report"
2+
description: Report a bug with Python.org website to help us improve
3+
title: "Bug: <title>"
4+
labels: ["Bug", "Triage Required"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This is the repository and issue tracker for https://www.python.org website.
11+
12+
If you're looking to file an issue with CPython itself, please go to
13+
https://github.com/python/cpython/issues/new/choose
14+
15+
Issues related to Python's documentation (https://docs.python.org) can
16+
also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md.
17+
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: "Describe the bug"
22+
description: A clear and concise description of what the bug is.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: reproduction
28+
attributes:
29+
label: "To Reproduce"
30+
description: Steps to reproduce the behavior
31+
placeholder: |
32+
1. Go to '...'
33+
2. Click on '....'
34+
3. Scroll down to '....'
35+
4. See error
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: expected
41+
attributes:
42+
label: "Expected behavior"
43+
description: A clear and concise description of what you expected to happen.
44+
validations:
45+
required: true
46+
47+
- type: input
48+
id: reprod-url
49+
attributes:
50+
label: "URL to the issue"
51+
description: Please enter the URL to provide a reproduction of the issue, if applicable
52+
placeholder: ex. https://python.org/my-issue/here
53+
validations:
54+
required: false
55+
56+
- type: textarea
57+
id: screenshot
58+
attributes:
59+
label: "Screenshots"
60+
description: If applicable, add screenshots to help explain your problem.
61+
value: |
62+
"![SCREENSHOT_DESCRIPTION](SCREENSHOT_LINK.png)"
63+
render: bash
64+
validations:
65+
required: false
66+
67+
- type: dropdown
68+
id: browsers
69+
attributes:
70+
label: "Browsers"
71+
description: What browsers are you seeing the problem on?
72+
multiple: true
73+
options:
74+
- Firefox
75+
- Chrome
76+
- Safari
77+
- Microsoft Edge
78+
- Other
79+
validations:
80+
required: true
81+
82+
- type: dropdown
83+
id: os
84+
attributes:
85+
label: "Operating System"
86+
description: What operating system are you using?
87+
options:
88+
- Windows
89+
- macOS
90+
- Linux
91+
- iOS
92+
- Android
93+
- Other
94+
validations:
95+
required: true
96+
97+
- type: input
98+
id: version
99+
attributes:
100+
label: "Browser Version"
101+
description: What version of the browser are you using?
102+
placeholder: "e.g. 22"
103+
validations:
104+
required: false
105+
106+
- type: textarea
107+
id: logs
108+
attributes:
109+
label: "Relevant log output"
110+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
111+
render: shell
112+
validations:
113+
required: false
114+
115+
- type: textarea
116+
id: additional
117+
attributes:
118+
label: "Additional context"
119+
description: Add any other context about the problem here.
120+
validations:
121+
required: false

‎.github/ISSUE_TEMPLATE/DOCS.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Documentation Update"
2+
description: Create an issue for documentation changes
3+
title: "Docs: <title>"
4+
labels: ["Documentation"]
5+
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: "Summary"
11+
description: Provide a brief summary of your request
12+
placeholder: We need to update the documentation to include information about...
13+
validations:
14+
required: true

‎.github/ISSUE_TEMPLATE/REQUEST.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: "Feature Request"
2+
description: Suggest an idea for www.python.org
3+
title: "Enhancement: <title>"
4+
labels: ["Enhancement"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This is the repository and issue tracker for https://www.python.org website.
11+
12+
If you're looking to file an issue with CPython itself, please go to
13+
https://github.com/python/cpython/issues/new/choose
14+
15+
Issues related to Python's documentation (https://docs.python.org) can
16+
also be filed at https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md.
17+
18+
- type: textarea
19+
id: problem
20+
attributes:
21+
label: "Is your feature request related to a problem? Please describe."
22+
description: A clear and concise description of what the problem is.
23+
placeholder: Ex. I'm always frustrated when [...]
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: solution
29+
attributes:
30+
label: "Describe the solution you'd like"
31+
description: A clear and concise description of what you want to happen.
32+
placeholder: Ex. It would be great if [...]
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: basic_example
38+
attributes:
39+
label: "Basic Example"
40+
description: Provide some basic examples of your feature request.
41+
placeholder: Describe how your feature would work with a simple example.
42+
validations:
43+
required: false
44+
45+
- type: textarea
46+
id: alternatives
47+
attributes:
48+
label: "Describe alternatives you've considered"
49+
description: A clear and concise description of any alternative solutions or features you've considered.
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: drawbacks
55+
attributes:
56+
label: "Drawbacks and Impact"
57+
description: What are the drawbacks or impacts of your feature request?
58+
placeholder: Describe any potential drawbacks or impacts of implementing this feature.
59+
validations:
60+
required: false
61+
62+
- type: textarea
63+
id: additional_context
64+
attributes:
65+
label: "Additional context"
66+
description: Add any other context or screenshots about the feature request here.
67+
validations:
68+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.md

-45
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: CPython Documentation
4+
url: https://docs.python.org/
5+
about: Official CPython documentation - please check here before opening an issue.
6+
- name: Python Website
7+
url: https://python.org/
8+
about: For all things Python
9+
- name: PyPI Issues / Support
10+
url: https://github.com/pypi/support
11+
about: For issues with PyPI itself, PyPI accounts, or with packages hosted on PyPI.
12+
- name: CPython Issues
13+
url: https://github.com/python/cpython/issues
14+
about: For issues with the CPython interpreter itself.

‎.github/ISSUE_TEMPLATE/feature_request.md

-27
This file was deleted.

0 commit comments

Comments
 (0)