跳到内容

帮助 SQLModel - 获取帮助

你喜欢 SQLModel 吗？

你想帮助 SQLModel、其他用户和作者吗？

或者你想获得 SQLModel 的帮助吗？

有一些非常简单的方法可以提供帮助（其中一些只需一两次点击）。

也有几种方法可以获得帮助。

订阅 FastAPI 及相关新闻简报

您可以订阅（不频繁的）FastAPI 及相关新闻简报，以了解最新消息：

  • 关于 FastAPI 及相关项目（包括 SQLModel）的新闻 🚀
  • 指南 📝
  • 功能 ✨
  • 重大变更 🚨
  • 提示和技巧 ✅

在 GitHub 上为 SQLModel 点赞

您可以在 GitHub 上“点赞”SQLModel（点击右上角的星标按钮）：https://github.com/fastapi/sqlmodel。⭐️

通过点赞，其他用户将更容易找到它，并看到它已经对其他人有用了。

关注 GitHub 仓库以获取发布通知

您可以在 GitHub 上“关注”SQLModel（点击右上角的“关注”按钮）：https://github.com/fastapi/sqlmodel。👀

在那里您可以选择“仅发布”。

通过这样做，每当 SQLModel 有新版本发布（包含错误修复和新功能）时，您都会收到通知（通过电子邮件）。

与作者联系

您可以与我（Sebastián Ramírez / tiangolo），即作者联系。

您可以

  • 在 GitHub 上关注我.
    • 查看我创建的其他可能对您有帮助的开源项目。
    • 关注我，以便在我创建新的开源项目时收到通知。
  • 在 Twitter 上关注我.
    • 告诉我您如何使用 SQLModel（我喜欢听到这些）。
    • 在我发布公告或新工具时收到通知。
  • 在 Linkedin 上与我联系.
    • 在我发布公告或新工具时收到通知（尽管我更常用 Twitter 🤷‍♂）。
  • 在 Dev.to 或 Medium 上阅读我写的文章（或关注我）。
    • 阅读其他想法、文章，并了解我创建的工具。
    • 关注我，以便在我发布新内容时阅读。

发推文谈论 SQLModel

发推文谈论 SQLModel，让我和他人知道你为什么喜欢它。🎉

我喜欢了解 SQLModel 的使用方式、你喜欢它的哪些方面、你在哪个项目/公司中使用它等等。

在 GitHub 上帮助他人解决问题

您可以尝试帮助他人解决他们的问题：

在许多情况下，您可能已经知道这些问题的答案。🤓

请记住，最重要的一点是：尽量友善。人们带着沮丧而来，很多时候提问方式并不理想，但请尽力保持友善。🤗

我们的目标是让 SQLModel 社区友善和热情。同时，不接受欺凌或对他人不尊重的行为。我们必须互相照顾。

以下是如何帮助他人解决问题（在讨论或问题中）：

理解问题

  • 检查您是否能理解提问者的目的和用例。

  • 然后检查问题（绝大多数是问题）是否清晰。

  • 在许多情况下，提出的问题是关于用户想象的解决方案，但可能存在一个更好的方案。如果您能更好地理解问题和用例，您可能会提出一个更好的替代解决方案。

  • 如果您无法理解问题，请要求更多细节。

重现问题

在大多数情况下，大多数问题都与提问者的原始代码有关。

在很多情况下，他们只会复制部分代码，但这不足以重现问题。

  • 您可以要求他们提供一个最小、可重现的示例，您可以复制粘贴并在本地运行，以查看他们遇到的相同错误或行为，或更好地理解他们的用例。

  • 如果您非常慷慨，可以尝试根据问题描述自行创建示例。但请记住，这可能需要大量时间，最好先请他们澄清问题。

提出解决方案

  • 在能够理解问题之后，您可以给他们一个可能的答案。

  • 在许多情况下，最好理解他们潜在的问题或用例，因为可能存在比他们尝试的更好的解决方法。

请求关闭

如果他们回复，很可能您已经解决了他们的问题，恭喜，您是英雄！🦸

  • 现在，如果解决了他们的问题，您可以请他们

    • 在 GitHub 讨论区：将评论标记为答案。
    • 在 GitHub 问题区：关闭问题。

关注 GitHub 仓库

您可以在 GitHub 上“关注”SQLModel（点击右上角的“关注”按钮）：https://github.com/fastapi/sqlmodel。👀

如果您选择“正在关注”而不是“仅发布”，则当有人创建新问题或提问时，您将收到通知。您还可以指定只希望收到有关新问题、讨论或拉取请求等的通知。

然后你可以尝试帮助他们解决这些问题。

提问

您可以在 GitHub 仓库中创建一个新问题，例如：

  • 提出问题或询问问题。
  • 提出新的功能。

注意：如果您这样做，那么我也会请您帮助他人。😉

审查拉取请求

您可以帮助我审查其他人的拉取请求。

再次，请尽力友善。🤗

以下是审查拉取请求时需要注意和如何审查的事项：

理解问题

  • 首先，确保您理解拉取请求试图解决的问题。它可能在 GitHub 讨论或问题中有更长的讨论。

  • 此外，拉取请求很可能实际上不需要，因为问题可以用不同的方式解决。然后您可以提出或询问相关内容。

不必担心风格

  • 不必太担心提交消息的风格，我会手动调整提交并进行压缩合并。

  • 也不必担心风格规则，已经有自动化工具进行检查。

如果还有其他风格或一致性需求，我会直接提出，或者我会在上面添加包含所需更改的提交。

检查代码

  • 检查并阅读代码，看看它是否有意义，在本地运行并查看它是否真正解决了问题。

  • 然后评论说你这样做了，这样我就会知道你真的检查过了。

信息

不幸的是，我不能简单地信任那些只有几个审批的 PR。

曾多次发生过有 3、5 个或更多审批的 PR，可能因为描述很吸引人，但当我检查 PR 时，它们实际上是损坏的、有 bug，或者没有解决它们声称要解决的问题。😅

所以，你真正阅读并运行代码，并在评论中告诉我你这样做了，这非常重要。🤓

  • 如果 PR 可以简化，您可以要求这样做，但不必过于挑剔，可能存在许多主观观点（我也有我自己的观点🙈），因此最好专注于基本的事情。

测试

  • 帮助我检查 PR 是否有测试。

  • 检查 PR 之前测试是否失败。🚨

  • 然后检查 PR 之后测试是否通过。✅

  • 许多 PR 没有测试，你可以提醒他们添加测试，甚至可以建议一些测试。这是最耗时的事情之一，你在这方面可以提供很大帮助。

  • 然后也评论你尝试了什么，这样我就会知道你检查过了。🤓

创建拉取请求

您可以通过拉取请求贡献源代码，例如

  • 修复你在文档中发现的拼写错误。
  • 提出新的文档章节。
  • 修复现有问题/错误。
    • 确保添加测试。
  • 添加新功能。
    • 确保添加测试。
    • 如果相关，请确保添加文档。

帮助维护 SQLModel

帮助我维护 SQLModel！🤓

有很多工作要做，其中大部分工作您都可以完成。

您现在可以做的主要任务是

这两项任务是最耗时的。这是维护 SQLModel 的主要工作。

如果您能在这方面帮助我，您就是在帮助我维护 SQLModel，并确保它能更快更好地发展。🚀

加入聊天

加入 👥 FastAPI 及相关 Discord 聊天服务器 👥，与社区中的其他人一起交流。有一个 #sqlmodel 频道。

提示

有关问题，请在 GitHub 讨论区提问，在那里您更有可能获得帮助。

仅将聊天用于其他一般性对话。

不要在聊天中提问

请记住，由于聊天允许更“自由的对话”，所以很容易提出过于宽泛且难以回答的问题，因此您可能无法收到答案。

在 GitHub 上，模板会引导您提出正确的问题，这样您就能更容易地得到一个好的答案，甚至在提问之前就自己解决问题。在 GitHub 上，我可以确保我总是回答所有问题，即使需要一些时间。我个人无法在聊天中做到这一点。😅

聊天中的对话也不如 GitHub 中容易搜索，因此问题和答案可能会在对话中丢失。

另一方面，聊天中有成千上万的用户，所以您很有可能在那里找到人聊天，几乎所有时间都可以。😄

您还可以通过 GitHub 赞助在经济上支持作者（我）。

在那里你可以给我买杯咖啡 ☕️ 表示感谢。😄

正如您在文档中看到的那样，SQLModel 站在 Pydantic 和 SQLAlchemy 这两个巨人的肩膀上。

您还可以赞助

谢谢！🚀