mirror of
https://github.com/PaiGramTeam/sqlmodel.git
synced 2024-11-23 00:01:34 +00:00
109 lines
5.0 KiB
Markdown
109 lines
5.0 KiB
Markdown
# Help SQLModel - Get Help
|
|
|
|
Do you like **SQLModel**?
|
|
|
|
Would you like to help SQLModel, other users, and the author?
|
|
|
|
Or would you like to get help with **SQLModel**?
|
|
|
|
There are very simple ways to help (several involve just one or two clicks).
|
|
|
|
And there are several ways to get help too.
|
|
|
|
## Subscribe to the FastAPI and Friends newsletter
|
|
|
|
You can subscribe to the (infrequent) [**FastAPI and friends** newsletter](/newsletter/){.internal-link target=_blank} to stay updated about:
|
|
|
|
* News about FastAPI and friends, including SQLModel 🚀
|
|
* Guides 📝
|
|
* Features ✨
|
|
* Breaking changes 🚨
|
|
* Tips and tricks ✅
|
|
|
|
## Star **SQLModel** in GitHub
|
|
|
|
You can "star" SQLModel in GitHub (clicking the star button at the top right): <a href="https://github.com/tiangolo/sqlmodel" class="external-link" target="_blank">https://github.com/tiangolo/sqlmodel</a>. ⭐️
|
|
|
|
By adding a star, other users will be able to find it more easily and see that it has been already useful for others.
|
|
|
|
## Watch the GitHub repository for releases
|
|
|
|
You can "watch" SQLModel in GitHub (clicking the "watch" button at the top right): <a href="https://github.com/tiangolo/sqlmodel" class="external-link" target="_blank">https://github.com/tiangolo/sqlmodel</a>. 👀
|
|
|
|
There you can select "Releases only".
|
|
|
|
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.
|
|
|
|
## Connect with the author
|
|
|
|
You can connect with <a href="https://tiangolo.com" class="external-link" target="_blank">me (Sebastián Ramírez / `tiangolo`)</a>, the author.
|
|
|
|
You can:
|
|
|
|
* <a href="https://github.com/tiangolo" class="external-link" target="_blank">Follow me on **GitHub**</a>.
|
|
* See other Open Source projects I have created that could help you.
|
|
* Follow me to see when I create a new Open Source project.
|
|
* <a href="https://twitter.com/tiangolo" class="external-link" target="_blank">Follow me on **Twitter**</a>.
|
|
* Tell me how you use SQLModel (I love to hear that).
|
|
* Hear when I make announcements or release new tools.
|
|
* <a href="https://www.linkedin.com/in/tiangolo/" class="external-link" target="_blank">Connect with me on **Linkedin**</a>.
|
|
* Hear when I make announcements or release new tools (although I use Twitter more often 🤷♂).
|
|
* Read what I write (or follow me) on <a href="https://dev.to/tiangolo" class="external-link" target="_blank">**Dev.to**</a> or <a href="https://medium.com/@tiangolo" class="external-link" target="_blank">**Medium**</a>.
|
|
* Read other ideas, articles, and read about tools I have created.
|
|
* Follow me to read when I publish something new.
|
|
|
|
## Tweet about **SQLModel**
|
|
|
|
<a href="https://twitter.com/compose/tweet?text=I'm loving SQLModel because... https://github.com/tiangolo/sqlmodel cc: @tiangolo" class="external-link" target="_blank">Tweet about **SQLModel**</a> and let me and others know why you like it. 🎉
|
|
|
|
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.
|
|
|
|
## Help others with issues in GitHub
|
|
|
|
You can see <a href="https://github.com/tiangolo/sqlmodel/issues" class="external-link" target="_blank">existing issues</a> and try and help others, most of the times they are questions that you might already know the answer for. 🤓
|
|
|
|
## Watch the GitHub repository
|
|
|
|
You can "watch" SQLModel in GitHub (clicking the "watch" button at the top right): <a href="https://github.com/tiangolo/sqlmodel" class="external-link" target="_blank">https://github.com/tiangolo/sqlmodel</a>. 👀
|
|
|
|
If you select "Watching" instead of "Releases only" you will receive notifications when someone creates a new issue.
|
|
|
|
Then you can try and help them solve those issues.
|
|
|
|
## Create issues
|
|
|
|
You can <a href="https://github.com/tiangolo/sqlmodel/issues/new/choose" class="external-link" target="_blank">create a new issue</a> in the GitHub repository, for example to:
|
|
|
|
* Ask a **question** or ask about a **problem**.
|
|
* Suggest a new **feature**.
|
|
|
|
**Note**: if you create an issue, then I'm going to ask you to also help others. 😉
|
|
|
|
## Create a Pull Request
|
|
|
|
You can [contribute](contributing.md){.internal-link target=_blank} to the source code with Pull Requests, for example:
|
|
|
|
* To fix a typo you found on the documentation.
|
|
* To propose new documentation sections.
|
|
* To fix an existing issue/bug.
|
|
* To add a new feature.
|
|
|
|
## Sponsor the author
|
|
|
|
You can also financially support the author (me) through <a href="https://github.com/sponsors/tiangolo" class="external-link" target="_blank">GitHub sponsors</a>.
|
|
|
|
There you could buy me a coffee ☕️ to say thanks. 😄
|
|
|
|
## Sponsor the tools that power SQLModel
|
|
|
|
As you have seen in the documentation, SQLModel stands on the shoulders of giants, Pydantic and SQLAlchemy.
|
|
|
|
You can also sponsor:
|
|
|
|
* <a href="https://github.com/sponsors/samuelcolvin" class="external-link" target="_blank">Samuel Colvin (Pydantic)</a>
|
|
* <a href="https://github.com/sponsors/sqlalchemy" class="external-link" target="_blank">SQLAlchemy</a>
|
|
|
|
---
|
|
|
|
Thanks! 🚀
|