Skip to content

Commit 624a214

Browse files
tiangolotiangolo
authored
🔧 Add template for GitHub Discussion questions and update issues template (fastapi#544)
1 parent 7b3148c commit 624a214

File tree

2 files changed

+170
-10
lines changed

2 files changed

+170
-10
lines changed

‎.github/DISCUSSION_TEMPLATE/questions.yml‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
labels: [question]
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Thanks for your interest in SQLModel! 🚀
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+
If more SQLModel 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 the SQLModel documentation, with the integrated search.
34+
required: true
35+
- label: I already searched in Google "How to X in SQLModel" and didn't find any information.
36+
required: true
37+
- label: I already read and followed all the tutorial in the docs and didn't find an answer.
38+
required: true
39+
- label: I already checked if it is not related to SQLModel but to [Pydantic](https://github.com/samuelcolvin/pydantic).
40+
required: true
41+
- label: I already checked if it is not related to SQLModel but to [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).
42+
required: true
43+
- type: checkboxes
44+
id: help
45+
attributes:
46+
label: Commit to Help
47+
description: |
48+
After submitting this, I commit to one of:
49+
50+
* Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
51+
* 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.
52+
* Review one Pull Request by downloading the code and following all the review process](https://sqlmodel.tiangolo.com/help/#review-pull-requests).
53+
54+
options:
55+
- label: I commit to help with one of those options 👆
56+
required: true
57+
- type: textarea
58+
id: example
59+
attributes:
60+
label: Example Code
61+
description: |
62+
Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
63+
64+
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.
65+
66+
placeholder: |
67+
from typing import Optional
68+
69+
from sqlmodel import Field, Session, SQLModel, create_engine
70+
71+
72+
class Hero(SQLModel, table=True):
73+
id: Optional[int] = Field(default=None, primary_key=True)
74+
name: str
75+
secret_name: str
76+
age: Optional[int] = None
77+
78+
79+
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
80+
81+
engine = create_engine("sqlite:///database.db")
82+
83+
84+
SQLModel.metadata.create_all(engine)
85+
86+
with Session(engine) as session:
87+
session.add(hero_1)
88+
session.commit()
89+
session.refresh(hero_1)
90+
print(hero_1)
91+
render: python
92+
validations:
93+
required: true
94+
- type: textarea
95+
id: description
96+
attributes:
97+
label: Description
98+
description: |
99+
What is the problem, question, or error?
100+
101+
Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
102+
placeholder: |
103+
* Create a Hero model.
104+
* Create a Hero instance.
105+
* Save it to a SQLite database.
106+
* Check the data with DB Browser for SQLite.
107+
* There's only one hero there, but I expected it to include many others recruited by the first one.
108+
validations:
109+
required: true
110+
- type: dropdown
111+
id: os
112+
attributes:
113+
label: Operating System
114+
description: What operating system are you on?
115+
multiple: true
116+
options:
117+
- Linux
118+
- Windows
119+
- macOS
120+
- Other
121+
validations:
122+
required: true
123+
- type: textarea
124+
id: os-details
125+
attributes:
126+
label: Operating System Details
127+
description: You can add more details about your operating system here, in particular if you chose "Other".
128+
- type: input
129+
id: sqlmodel-version
130+
attributes:
131+
label: SQLModel Version
132+
description: |
133+
What SQLModel version are you using?
134+
135+
You can find the SQLModel version with:
136+
137+
```bash
138+
python -c "import sqlmodel; print(sqlmodel.__version__)"
139+
```
140+
validations:
141+
required: true
142+
- type: input
143+
id: python-version
144+
attributes:
145+
label: Python Version
146+
description: |
147+
What Python version are you using?
148+
149+
You can find the Python version with:
150+
151+
```bash
152+
python --version
153+
```
154+
validations:
155+
required: true
156+
- type: textarea
157+
id: context
158+
attributes:
159+
label: Additional Context
160+
description: Add any additional context information or screenshots you think are useful.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ body:
88
Thanks for your interest in SQLModel! 🚀
99
1010
Please follow these instructions, fill every question, and do every step. 🙏
11-
12-
I'm asking this because answering questions and solving problems in GitHub issues is what consumes most of the time.
13-
14-
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 issues.
11+
12+
I'm asking this because answering questions and solving problems in GitHub is what consumes most of the time.
13+
14+
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.
1515
1616
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.
1717
1818
If more SQLModel users came to help others like them just a little bit more, it would be much less effort for them (and you and me 😅).
1919
2020
By asking questions in a structured way (following this) it will be much easier to help you.
21-
21+
2222
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. 😎
2323
24-
As there are too many issues with questions, I'll have to 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. 🤓
24+
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. 🤓
2525
- type: checkboxes
2626
id: checks
2727
attributes:
2828
label: First Check
2929
description: Please confirm and check all the following options.
3030
options:
31-
- label: I added a very descriptive title to this issue.
31+
- label: I added a very descriptive title here.
3232
required: true
33-
- label: I used the GitHub search to find a similar issue and didn't find it.
33+
- label: I used the GitHub search to find a similar question and didn't find it.
3434
required: true
3535
- label: I searched the SQLModel documentation, with the integrated search.
3636
required: true
@@ -48,10 +48,10 @@ body:
4848
label: Commit to Help
4949
description: |
5050
After submitting this, I commit to one of:
51-
51+
5252
* Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
5353
* 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.
54-
* Implement a Pull Request for a confirmed bug.
54+
* Review one Pull Request by downloading the code and following all the review process](https://sqlmodel.tiangolo.com/help/#review-pull-requests).
5555
5656
options:
5757
- label: I commit to help with one of those options 👆

0 commit comments

Comments
 (0)