Skip to content

Commit 4df6235

Browse files
committed
📝 Update and simplify docs about help and management
1 parent 075fecb commit 4df6235

4 files changed

Lines changed: 31 additions & 348 deletions

File tree

docs/help.md

Lines changed: 28 additions & 196 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
1-
# Help SQLModel - Get Help
1+
# Help
22

3-
Do you like **SQLModel**?
3+
Would you like to help SQLModel or get help about SQLModel?
44

5-
Would you like to help SQLModel, other users, and the author?
5+
There are very simple ways to help and get help.
66

7-
Or would you like to get help with **SQLModel**?
7+
## Subscribe to the newsletter
88

9-
There are very simple ways to help (several involve just one or two clicks).
10-
11-
And there are several ways to get help too.
12-
13-
## Subscribe to the FastAPI and Friends newsletter
14-
15-
You can subscribe to the (infrequent) [**FastAPI and friends** newsletter](https://fastapi.tiangolo.com/newsletter) to stay updated about:
9+
You can subscribe to the (infrequent) [**FastAPI and friends** newsletter](https://fastapi.tiangolo.com/newsletter/) to stay updated about:
1610

1711
* News about FastAPI and friends, including SQLModel 🚀
1812
* Guides 📝
1913
* Features ✨
2014
* Breaking changes 🚨
2115
* Tips and tricks ✅
2216

17+
## Follow FastAPI online
18+
19+
You can follow **FastAPI** online in several places:
20+
21+
* [@fastapi on **X / Twitter**](https://x.com/fastapi)
22+
* [@fastapi.tiangolo.com on **Bluesky**](https://bsky.app/profile/fastapi.tiangolo.com)
23+
* [FastAPI on **LinkedIn**](https://www.linkedin.com/company/fastapi/)
24+
2325
## Star **SQLModel** in GitHub
2426

2527
You can "star" SQLModel in GitHub (clicking the star button at the top right): [https://github.com/fastapi/sqlmodel](https://github.com/fastapi/sqlmodel). ⭐️
@@ -34,89 +36,26 @@ There you can select "Releases only".
3436

3537
By doing it, you will receive notifications (in your email) whenever there's a new release (a new version) of **SQLModel** with bug fixes and new features.
3638

37-
## Connect with the author
39+
## Follow the author
3840

39-
You can connect with [me (Sebastián Ramírez / `tiangolo`)](https://tiangolo.com), the author.
41+
You can follow [me (Sebastián Ramírez / `tiangolo`)](https://tiangolo.com), the author in a few places, to hear when I have news to share about FastAPI and friends:
4042

41-
You can:
42-
43-
* [Follow me on **GitHub**](https://github.com/tiangolo).
44-
* See other Open Source projects I have created that could help you.
45-
* Follow me to see when I create a new Open Source project.
46-
* [Follow me on **Twitter**](https://twitter.com/tiangolo).
47-
* Tell me how you use SQLModel (I love to hear that).
48-
* Hear when I make announcements or release new tools.
49-
* [Connect with me on **Linkedin**](https://www.linkedin.com/in/tiangolo/).
50-
* Hear when I make announcements or release new tools (although I use Twitter more often 🤷‍♂).
51-
* Read what I write (or follow me) on [**Dev.to**](https://dev.to/tiangolo) or [**Medium**](https://medium.com/@tiangolo).
52-
* Read other ideas, articles, and read about tools I have created.
53-
* Follow me to read when I publish something new.
54-
55-
## Tweet about **SQLModel**
56-
57-
[Tweet about **SQLModel**](https://twitter.com/compose/tweet?text=I'm loving SQLModel because... https://github.com/fastapi/sqlmodel cc: @tiangolo) and let me and others know why you like it. 🎉
58-
59-
I love to hear about how **SQLModel** is being used, what you have liked in it, in which project/company are you using it, etc.
43+
* [@tiangolo on **GitHub**](https://github.com/tiangolo).
44+
* [@tiangolo on **X (Twitter)**](https://x.com/tiangolo)
45+
* [@tiangolo.com on **Bluesky**](https://bsky.app/profile/tiangolo.com)
46+
* [@tiangolo on **LinkedIn**](https://www.linkedin.com/in/tiangolo/).
6047

6148
## Help others with questions in GitHub
6249

63-
You can try and help others with their questions in:
64-
65-
* [GitHub Discussions](https://github.com/fastapi/sqlmodel/discussions/categories/questions?discussions_q=category%3AQuestions+is%3Aunanswered)
66-
* [GitHub Issues](https://github.com/fastapi/sqlmodel/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aquestion+-label%3Aanswered+)
50+
You can try and help others with their questions in [GitHub Discussions](https://github.com/fastapi/sqlmodel/discussions/categories/questions?discussions_q=category%3AQuestions+is%3Aunanswered).
6751

6852
In many cases you might already know the answer for those questions. 🤓
6953

70-
Just remember, the most important point is: try to be kind. People come with their frustrations and in many cases don't ask in the best way, but try as best as you can to be kind. 🤗
71-
72-
The idea is for the **SQLModel** community to be kind and welcoming. At the same time, don't accept bullying or disrespectful behavior towards others. We have to take care of each other.
73-
74-
---
75-
76-
Here's how to help others with questions (in discussions or issues):
77-
78-
### Understand the question
79-
80-
* Check if you can understand what is the **purpose** and use case of the person asking.
81-
82-
* Then check if the question (the vast majority are questions) is **clear**.
83-
84-
* In many cases the question asked is about an imaginary solution from the user, but there might be a **better** one. If you can understand the problem and use case better, you might be able to suggest a better **alternative solution**.
85-
86-
* If you can't understand the question, ask for more **details**.
87-
88-
### Reproduce the problem
89-
90-
For most of the cases and most of the questions there's something related to the person's **original code**.
54+
Just remember, the most important point is: try to be kind. 🤗
9155

92-
In many cases they will only copy a fragment of the code, but that's not enough to **reproduce the problem**.
56+
### How to Help
9357

94-
* You can ask them to provide a [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example), that you can **copy-paste** and run locally to see the same error or behavior they are seeing, or to understand their use case better.
95-
96-
* If you are feeling too generous, you can try to **create an example** like that yourself, just based on the description of the problem. Just have in mind that this might take a lot of time and it might be better to ask them to clarify the problem first.
97-
98-
### Suggest solutions
99-
100-
* After being able to understand the question, you can give them a possible **answer**.
101-
102-
* In many cases, it's better to understand their **underlying problem or use case**, because there might be a better way to solve it than what they are trying to do.
103-
104-
### Ask to close
105-
106-
If they reply, there's a high chance you would have solved their problem, congrats, **you're a hero**! 🦸
107-
108-
* Now, if that solved their problem, you can ask them to:
109-
110-
* In GitHub Discussions: mark the comment as the **answer**.
111-
* In GitHub Issues: **close** the issue**.
112-
113-
## Watch the GitHub repository
114-
115-
You can "watch" SQLModel in GitHub (clicking the "watch" button at the top right): [https://github.com/fastapi/sqlmodel](https://github.com/fastapi/sqlmodel). 👀
116-
117-
If you select "Watching" instead of "Releases only" you will receive notifications when someone creates a new issue or question. You can also specify that you only want to be notified about new issues, or discussions, or PRs, etc.
118-
119-
Then you can try and help them solve those questions.
58+
Follow the [guide on how to help](https://tiangolo.com/open-source/help/#help-others-with-questions-in-github) here.
12059

12160
## Ask Questions
12261

@@ -125,93 +64,7 @@ You can [create a new question](https://github.com/fastapi/sqlmodel/discussions/
12564
* Ask a **question** or ask about a **problem**.
12665
* Suggest a new **feature**.
12766

128-
**Note**: if you do it, then I'm going to ask you to also help others. 😉
129-
130-
## Review Pull Requests
131-
132-
You can help me review pull requests from others.
133-
134-
Again, please try your best to be kind. 🤗
135-
136-
---
137-
138-
Here's what to have in mind and how to review a pull request:
139-
140-
### Understand the problem
141-
142-
* First, make sure you **understand the problem** that the pull request is trying to solve. It might have a longer discussion in a GitHub Discussion or issue.
143-
144-
* There's also a good chance that the pull request is not actually needed because the problem can be solved in a **different way**. Then you can suggest or ask about that.
145-
146-
### Don't worry about style
147-
148-
* Don't worry too much about things like commit message styles, I will squash and merge customizing the commit manually.
149-
150-
* Also don't worry about style rules, there are already automatized tools checking that.
151-
152-
And if there's any other style or consistency need, I'll ask directly for that, or I'll add commits on top with the needed changes.
153-
154-
### Check the code
155-
156-
* Check and read the code, see if it makes sense, **run it locally** and see if it actually solves the problem.
157-
158-
* Then **comment** saying that you did that, that's how I will know you really checked it.
159-
160-
/// note
161-
162-
Unfortunately, I can't simply trust PRs that just have several approvals.
163-
164-
Several times it has happened that there are PRs with 3, 5 or more approvals, probably because the description is appealing, but when I check the PRs, they are actually broken, have a bug, or don't solve the problem they claim to solve. 😅
165-
166-
So, it's really important that you actually read and run the code, and let me know in the comments that you did. 🤓
167-
168-
///
169-
170-
* If the PR can be simplified in a way, you can ask for that, but there's no need to be too picky, there might be a lot of subjective points of view (and I will have my own as well 🙈), so it's better if you can focus on the fundamental things.
171-
172-
### Tests
173-
174-
* Help me check that the PR has **tests**.
175-
176-
* Check that the tests **fail** before the PR. 🚨
177-
178-
* Then check that the tests **pass** after the PR. ✅
179-
180-
* Many PRs don't have tests, you can **remind** them to add tests, or you can even **suggest** some tests yourself. That's one of the things that consume most time and you can help a lot with that.
181-
182-
* Then also comment what you tried, that way I'll know that you checked it. 🤓
183-
184-
## Create a Pull Request
185-
186-
You can [contribute](contributing.md) to the source code with Pull Requests, for example:
187-
188-
* To fix a typo you found on the documentation.
189-
* To propose new documentation sections.
190-
* To fix an existing issue/bug.
191-
* Make sure to add tests.
192-
* To add a new feature.
193-
* Make sure to add tests.
194-
* Make sure to add documentation if it's relevant.
195-
196-
Note that PRs from non-team members are not allowed to modify `pyproject.toml` or `uv.lock`, to prevent supply chain risk.
197-
If you would like to add a new dependency, create a new [Discussion](https://github.com/fastapi/sqlmodel/discussions/categories/questions) to explain why.
198-
199-
## Help Maintain SQLModel
200-
201-
Help me maintain **SQLModel**! 🤓
202-
203-
There's a lot of work to do, and for most of it, **YOU** can do it.
204-
205-
The main tasks that you can do right now are:
206-
207-
* [Help others with questions in GitHub](#help-others-with-questions-in-github) (see the section above).
208-
* [Review Pull Requests](#review-pull-requests) (see the section above).
209-
210-
Those two tasks are what **consume time the most**. That's the main work of maintaining SQLModel.
211-
212-
If you can help me with that, **you are helping me maintain SQLModel** and making sure it keeps **advancing faster and better**. 🚀
213-
214-
## Join the chat
67+
## Join the Chat
21568

21669
Join the 👥 [FastAPI and Friends Discord chat server](https://discord.gg/VQjSZaeJmf) 👥 and hang out with others in the community. There's a `#sqlmodel` channel.
21770

@@ -223,31 +76,10 @@ Use the chat only for other general conversations.
22376

22477
///
22578

226-
### Don't use the chat for questions
227-
228-
Have in mind that as chats allow more "free conversation", it's easy to ask questions that are too general and more difficult to answer, so, you might not receive answers.
229-
230-
In GitHub, the template will guide you to write the right question so that you can more easily get a good answer, or even solve the problem yourself even before asking. And in GitHub I can make sure I always answer everything, even if it takes some time. I can't personally do that with the chat. 😅
231-
232-
Conversations in the chat are also not as easily searchable as in GitHub, so questions and answers might get lost in the conversation.
233-
234-
On the other side, there are thousands of users in the chat, so there's a high chance you'll find someone to talk to there, almost all the time. 😄
235-
236-
## Sponsor the author
237-
238-
You can also financially support the author (me) through [GitHub sponsors](https://github.com/sponsors/tiangolo).
239-
240-
There you could buy me a coffee ☕️ to say thanks. 😄
241-
242-
## Sponsor the tools that power SQLModel
243-
244-
As you have seen in the documentation, SQLModel stands on the shoulders of giants, Pydantic and SQLAlchemy.
245-
246-
You can also sponsor:
79+
### Don't use the Chat for Questions
24780

248-
* [Samuel Colvin (Pydantic)](https://github.com/sponsors/samuelcolvin)
249-
* [SQLAlchemy](https://github.com/sponsors/sqlalchemy)
81+
Keep in mind that as chats allow more "free conversation", it's easy to ask questions that are too general and more difficult to answer, so, you might not receive answers.
25082

251-
---
83+
In GitHub, the template will guide you to write the right question so that you can more easily get a good answer, or even solve the problem yourself even before asking.
25284

253-
Thanks! 🚀
85+
Conversations in the chat systems are also not as easily searchable as in GitHub, they get lost.

0 commit comments

Comments
 (0)