Skip to content

Commit 8c8cc58

Browse files
jaracojaraco
authored
Merge pull request #2594 from webknjaz/maintenance/issue-forms
Introduce issue forms in the repo
2 parents 15249f1 + 9acf04c commit 8c8cc58

File tree

4 files changed

+343
-0
lines changed

4 files changed

+343
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
name: 🐛 Bug report
3+
description: >-
4+
Create a report to help us improve when
5+
something is not working correctly
6+
title: '[BUG] '
7+
labels:
8+
- bug
9+
- Needs Triage
10+
issue_body: false # default: true, adds a classic WSYWIG textarea, if on
11+
12+
body:
13+
- type: markdown
14+
attributes:
15+
value: >
16+
**Thank you for wanting to report a bug in setuptools!**
17+
18+
19+
⚠
20+
Verify first that your issue is not
21+
[already reported on GitHub][issue search] and keep in mind and
22+
keep in mind that we may have to keep the current behavior because
23+
[every change breaks someone's workflow][XKCD 1172].
24+
We try to be mindful about this.
25+
26+
Also test if the latest release and main branch are affected too.
27+
28+
29+
If you are seeking community support, please consider
30+
[starting a discussion][Discussions].
31+
32+
33+
Thank you for your collaboration!
34+
35+
36+
[Discussions]: https://github.com/pypa/setuptools/discussions
37+
38+
[issue search]: https://github.com/pypa/setuptools/search?q=is%3Aissue&type=issues
39+
40+
[XKCD 1172]: https://xkcd.com/1172/
41+
42+
- type: markdown
43+
attributes:
44+
value: >-
45+
**Environment**
46+
- type: input
47+
attributes:
48+
label: setuptools version
49+
placeholder: For example, setuptools===60.4.2
50+
validations:
51+
required: true
52+
- type: input
53+
attributes:
54+
label: Python version
55+
placeholder: For example, Python 3.10
56+
validations:
57+
required: true
58+
- type: input
59+
attributes:
60+
label: OS
61+
placeholder: For example, Gentoo Linux, RHEL 8, Arch Linux, macOS etc.
62+
validations:
63+
required: true
64+
- type: textarea
65+
attributes:
66+
label: Additional environment information
67+
description: >-
68+
Feel free to add more information about your environment here.
69+
placeholder: >-
70+
This is only happening when I run setuptools on my fridge's patched firmware 🤯
71+
72+
- type: textarea
73+
attributes:
74+
label: Description
75+
description: >-
76+
A clear and concise description of what the bug is.
77+
placeholder: >-
78+
I tried doing X and I expected it to result in Y because the docs
79+
mentioned Z but what happened next what totally unexpected!
80+
And here's why...
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
attributes:
86+
label: Expected behavior
87+
description: >-
88+
A clear and concise description of what you expected to happen.
89+
placeholder: >-
90+
I tried doing X and I expected it to result in Y. I'm confused...
91+
validations:
92+
required: true
93+
94+
- type: textarea
95+
attributes:
96+
label: How to Reproduce
97+
description: >-
98+
Describe the steps to reproduce this bug.
99+
placeholder: |
100+
1. Integrate setuptools via '...'
101+
2. Then run '...'
102+
3. An error occurs.
103+
validations:
104+
required: true
105+
106+
- type: textarea
107+
attributes:
108+
label: Output
109+
description: >-
110+
Paste the output of the steps above, including the commands
111+
themselves and setuptools' output/traceback etc.
112+
value: |
113+
```console
114+
115+
```
116+
validations:
117+
required: true
118+
119+
120+
- type: checkboxes
121+
attributes:
122+
label: Code of Conduct
123+
description: |
124+
Read the [PSF Code of Conduct][CoC] first.
125+
126+
[CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
127+
options:
128+
- label: I agree to follow the PSF Code of Conduct
129+
required: true
130+
...

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: false # default: true
3+
contact_links:
4+
- name: 🤔 Have questions or need support?
5+
url: https://github.com/pypa/setuptools/discussions
6+
about: This is a place for the community to exchange ideas and recipes
7+
- name: 💬 Discourse
8+
url: https://discuss.python.org/c/packaging
9+
about: |
10+
Please ask typical Q&A here: general ideas for Python packaging,
11+
questions about structuring projects and so on
12+
- name: >-
13+
💬 IRC: #pypa @ Freenode
14+
url: https://webchat.freenode.net/#pypa
15+
about: Chat with devs

‎.github/ISSUE_TEMPLATE/documentation-report.yml

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
name: 📝 Documentation Report
3+
title: '[Docs] '
4+
description: Ask us about docs
5+
labels:
6+
- documentation
7+
- Needs Triage
8+
# NOTE: issue body is enabled to allow screenshots
9+
issue_body: true # default: true, adds a classic WSYWIG textarea, if on
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: >
15+
**Thank you for wanting to report a problem with setuptools
16+
documentation!**
17+
18+
19+
Please fill out your suggestions below. If the problem seems
20+
straightforward, feel free to go ahead and
21+
submit a pull request instead!
22+
23+
24+
⚠
25+
Verify first that your issue is not [already reported on
26+
GitHub][issue search].
27+
28+
29+
If you are seeking community support, please consider
30+
[starting a discussion][Discussions].
31+
32+
33+
Thank you for your collaboration!
34+
35+
36+
[issue search]: https://github.com/pypa/setuptools/search?q=is%3Aissue&type=issues
37+
38+
[Discussions]: https://github.com/pypa/setuptools/discussions
39+
40+
- type: textarea
41+
attributes:
42+
label: Summary
43+
description: >
44+
Explain the problem briefly below, add suggestions to wording
45+
or structure.
46+
47+
48+
**HINT:** Did you know the documentation has a `View on GitHub`
49+
link on every page? Feel free to use it to start a pull request
50+
right from the GitHub UI!
51+
placeholder: >-
52+
I was reading the setuptools documentation of version X and I'm
53+
having problems understanding Y. It would be very helpful if that
54+
got rephrased as Z.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
attributes:
60+
label: OS / Environment
61+
description: >-
62+
Provide all relevant information below, e.g. OS version,
63+
browser, etc.
64+
placeholder: Fedora 33, Firefox etc.
65+
66+
67+
- type: checkboxes
68+
attributes:
69+
label: Code of Conduct
70+
description: |
71+
Read the [PSF Code of Conduct][CoC] first.
72+
73+
[CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
74+
options:
75+
- label: I agree to follow the PSF Code of Conduct
76+
required: true
77+
78+
79+
- type: markdown
80+
attributes:
81+
value: >
82+
83+
84+
### Additional Information
85+
86+
87+
Describe how this improves the documentation, e.g. before/after
88+
situation or screenshots.
89+
90+
91+
**HINT:** You can paste https://gist.github.com links for
92+
larger files.
93+
...

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
name: ✨ Feature request
3+
description: Suggest an idea for setuptools
4+
title: '[FR] '
5+
labels:
6+
- enhancement
7+
- Needs Triage
8+
issue_body: false # default: true, adds a classic WSYWIG textarea, if on
9+
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: >
14+
**Thank you for wanting to suggest a feature for setuptools!**
15+
16+
17+
💡
18+
Before you go ahead with your request, please first consider if it
19+
would be useful for majority of the setuptools users. As a general
20+
rule of thumb, any feature that is only of interest to a small sub
21+
group should be implemented in a third-party plugin or maybe even
22+
just your project alone. Be mindful of the fact that the core
23+
setuptools features have a broad impact.
24+
25+
26+
<details>
27+
<summary>
28+
❗ Every change breaks someone's workflow.
29+
</summary>
30+
31+
32+
[![❗ Every change breaks someone's workflow.](https://imgs.xkcd.com/comics/workflow.png)
33+
](https://xkcd.com/1172/)
34+
</details>
35+
36+
37+
⚠
38+
Verify first that your idea is not [already requested on GitHub][issue search].
39+
40+
41+
42+
[issue search]: https://github.com/pypa/setuptools/search?q=is%3Aissue&type=issues
43+
44+
- type: textarea
45+
attributes:
46+
label: What's the problem this feature will solve?
47+
description: >-
48+
What are you trying to do, that you are unable to achieve
49+
with setuptools as it currently stands?
50+
placeholder: >-
51+
I'm trying to do X and I'm missing feature Y for this to be
52+
easily achievable.
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
attributes:
58+
label: Describe the solution you'd like
59+
description: >
60+
Clear and concise description of what you want to happen.
61+
62+
63+
Provide examples of real world use cases that this would enable
64+
and how it solves the problem described above.
65+
placeholder: >-
66+
When I do X, I want to achieve Y in a situation when Z.
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
attributes:
72+
label: Alternative Solutions
73+
description: >-
74+
Have you tried to workaround the problem using other tools? Or a
75+
different approach to solving this issue? Please elaborate here.
76+
placeholder: >-
77+
I tried doing X, Y and Z. But they are subobpimal because of P.
78+
79+
- type: textarea
80+
attributes:
81+
label: Additional context
82+
description: >
83+
Add any other context, links, etc. about the feature here.
84+
Describe how the feature would be used, why it is needed and what
85+
it would solve.
86+
87+
88+
**HINT:** You can paste https://gist.github.com links for
89+
larger files.
90+
placeholder: >-
91+
I asked on https://stackoverflow.com/.... and the community
92+
advised me to do X, Y and Z.
93+
94+
95+
- type: checkboxes
96+
attributes:
97+
label: Code of Conduct
98+
description: |
99+
Read the [PSF Code of Conduct][CoC] first.
100+
101+
[CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
102+
options:
103+
- label: I agree to follow the PSF Code of Conduct
104+
required: true
105+
...

0 commit comments

Comments
 (0)