跳到内容

帮助 SQLModel - 获取帮助

您喜欢 SQLModel 吗？

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

或者您想获得关于 SQLModel 的帮助吗？

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

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

订阅 FastAPI 和 Friends 新闻简报

您可以订阅（不频繁的）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 Discussions 中：将评论标记为答案。
    • 在 GitHub Issues 中：关闭问题。

关注 GitHub 仓库

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

如果你选择“关注”而不是“仅发布”，当有人创建新的 issue 或问题时，你将收到通知。你还可以指定只接收关于新 issue、讨论或 PR 等的通知。

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

提问

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

  • 提出一个问题或询问一个难题。
  • 建议一个新功能。

注意：如果你提问了，我也会请你帮助其他人。 😉

审查拉取请求

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

再次强调，请尽力保持友善。🤗

以下是审查拉取请求时需要考虑的内容和步骤：

理解问题

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

  • 也有可能这个拉取请求实际上是不必要的，因为这个问题可以用不同的方式解决。那么你可以提出建议或询问。

不要担心代码风格

  • 不要太担心诸如提交信息风格之类的事情，我将手动压缩和合并提交。

  • 也不要担心代码风格规则，已经有自动化工具会检查这些。

如果还有其他风格或一致性的需求，我会直接提出，或者我在顶部添加提交并进行所需的更改。

检查代码

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

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

信息

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

有好几次，出现了一些有 3、5 个或更多批准的 PR，可能是因为描述很吸引人，但当我检查 PR 时，它们实际上是坏的，有 bug，或者没有解决他们声称要解决的问题。 😅

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

  • 如果可以以某种方式简化 PR，你可以要求这样做，但没有必要过于挑剔，可能有很多主观的观点（我也会有自己的观点🙈），所以最好专注于基本的事情。

测试

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

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

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

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

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

创建拉取请求

你可以通过拉取请求为源代码做出贡献，例如：

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

帮助维护 SQLModel

帮助我维护 SQLModel! 🤓

有很多工作要做，而且大部分工作，你可以做。

你现在可以做的主要任务是：

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

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

加入聊天

加入 👥 FastAPI 和朋友 Discord 聊天服务器 👥 并与社区中的其他人一起交流。有一个 #sqlmodel 频道。

提示

如有问题，请在 GitHub 讨论中提问，在那里你更有可能获得帮助。

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

不要在聊天中提问

请记住，由于聊天允许更“自由的对话”，因此很容易提出过于笼统且更难以回答的问题，因此，你可能不会收到答案。

在 GitHub 中，模板将引导你编写正确的问题，以便你可以更容易地获得好的答案，甚至在提问之前自己解决问题。而且在 GitHub 中，我可以确保我总是回答所有问题，即使这需要一些时间。我个人无法在聊天中做到这一点。😅

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

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

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

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

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

你也可以赞助：

谢谢！🚀