sqlmodel/docs/help.md

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{.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): https://github.com/tiangolo/sqlmodel. ⭐️

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): https://github.com/tiangolo/sqlmodel. 👀

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 me (Sebastián Ramírez / tiangolo), the author.

You can:

• Follow me on GitHub.
  • See other Open Source projects I have created that could help you.
  • Follow me to see when I create a new Open Source project.
• Follow me on Twitter.
  • Tell me how you use SQLModel (I love to hear that).
  • Hear when I make announcements or release new tools.
• Connect with me on Linkedin.
  • Hear when I make announcements or release new tools (although I use Twitter more often 🤷‍♂).
• Read what I write (or follow me) on Dev.to or Medium.
  • Read other ideas, articles, and read about tools I have created.
  • Follow me to read when I publish something new.

Tweet about SQLModel

Tweet about SQLModel 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 existing issues 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): https://github.com/tiangolo/sqlmodel. 👀

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 create a new issue 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{.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 GitHub sponsors.

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:

• Samuel Colvin (Pydantic)
• SQLAlchemy

---

Thanks! 🚀