Skip to content

Commit 993d52d

Browse files
authored
infra: update templates to new form style, add config links (#2571)
* infra: update templates to new form style, add config links * fix: update links * chore: casing * chore: no caps!
1 parent e4883ee commit 993d52d

File tree

6 files changed

+222
-72
lines changed

6 files changed

+222
-72
lines changed

.github/ISSUE_TEMPLATE/BUG.yml

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

.github/ISSUE_TEMPLATE/DOCS.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Documentation Update"
2+
description: Create an issue for documentation changes
3+
title: "Docs: <title>"
4+
labels: ["documentation"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This is the repository and issue tracker for the https://www.pyton.org website.
11+
12+
If you're looking to file an issue with CPython itself, please click here: [CPython Issues](https://github.com/python/cpython/issues/new/choose).
13+
14+
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).
15+
16+
- type: textarea
17+
id: summary
18+
attributes:
19+
label: "Summary"
20+
description: Provide a brief summary of your request
21+
placeholder: We need to update the documentation to include information about...
22+
validations:
23+
required: true

.github/ISSUE_TEMPLATE/REQUEST.yml

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