Skip to content

Commit 8c08ed4

Browse files
committed
feat(github): Add discussion template for structured Q&A support
1 parent f9895d1 commit 8c08ed4

1 file changed

Lines changed: 118 additions & 0 deletions

File tree

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
labels: [question]
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Thanks for your interest in this project! 🚀
7+
8+
Please follow these instructions, fill every question, and do every step. 🙏
9+
10+
I'm asking this because answering questions and solving problems in GitHub is what consumes most of the time.
11+
12+
I end up not being able to add new features, fix bugs, review pull requests, etc. as fast as I wish because I have to spend too much time handling questions.
13+
14+
All that, on top of all the incredible help provided by a bunch of community members, that give a lot of their time to come here and help others.
15+
16+
That's a lot of work, but if more users came to help others like them just a little bit more, it would be much less effort for them (and you and me 😅).
17+
18+
By asking questions in a structured way (following this) it will be much easier to help you.
19+
20+
And there's a high chance that you will find the solution along the way and you won't even have to submit it and wait for an answer. 😎
21+
22+
As there are too many questions, I'll have to discard and close the incomplete ones. That will allow me (and others) to focus on helping people like you that follow the whole process and help us help you. 🤓
23+
- type: checkboxes
24+
id: checks
25+
attributes:
26+
label: First Check
27+
description: Please confirm and check all the following options.
28+
options:
29+
- label: I added a very descriptive title here.
30+
required: true
31+
- label: I used the GitHub search to find a similar question and didn't find it.
32+
required: true
33+
- label: I searched in the documentation/README.
34+
required: true
35+
- label: I already searched in Google "How to do X" and didn't find any information.
36+
required: true
37+
- label: I already read and followed all the tutorial in the docs/README and didn't find an answer.
38+
required: true
39+
- type: checkboxes
40+
id: help
41+
attributes:
42+
label: Commit to Help
43+
description: |
44+
After submitting this, I commit to one of:
45+
46+
* Read open questions until I find 2 where I can help someone and add a comment to help there.
47+
* I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
48+
49+
options:
50+
- label: I commit to help with one of those options 👆
51+
required: false
52+
- type: textarea
53+
id: example
54+
attributes:
55+
label: Example Code
56+
description: |
57+
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
58+
59+
If I (or someone) can copy it, run it, and see it right away, there's a much higher chance I (or someone) will be able to help you.
60+
61+
placeholder: |
62+
Write your example code here.
63+
render: Text
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: description
68+
attributes:
69+
label: Description
70+
description: |
71+
What is the problem, question, or error?
72+
73+
Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
74+
placeholder: |
75+
* Open the browser and call the endpoint `/`.
76+
* It returns a JSON with `{"message": "Hello World"}`.
77+
* But I expected it to return `{"message": "Hello Morty"}`.
78+
validations:
79+
required: true
80+
- type: dropdown
81+
id: os
82+
attributes:
83+
label: Operating System
84+
description: What operating system are you on?
85+
multiple: true
86+
options:
87+
- Linux
88+
- Windows
89+
- macOS
90+
- Other
91+
validations:
92+
required: true
93+
- type: textarea
94+
id: os-details
95+
attributes:
96+
label: Operating System Details
97+
description: You can add more details about your operating system here, in particular if you chose "Other".
98+
validations:
99+
required: true
100+
- type: input
101+
id: python-version
102+
attributes:
103+
label: Python Version
104+
description: |
105+
What Python version are you using?
106+
107+
You can find the Python version with:
108+
109+
```bash
110+
python --version
111+
```
112+
validations:
113+
required: true
114+
- type: textarea
115+
id: context
116+
attributes:
117+
label: Additional Context
118+
description: Add any additional context information or screenshots you think are useful.

0 commit comments

Comments
 (0)