跳到内容

帮助 SQLModel - 获取帮助

你喜欢 SQLModel 吗?

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

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

有非常简单的方法可以提供帮助(有些只需点击一两下)。

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

订阅 FastAPI 及其朋友们(FastAPI and Friends)的通讯

你可以订阅(不定期发布的)FastAPI and friends 通讯,以获取最新消息,包括

  • 关于 FastAPI 及其朋友们(包括 SQLModel 🚀)的新闻
  • 指南 📝
  • 特性 ✨
  • 重大变更 🚨
  • 提示和技巧 ✅

在 GitHub 上为 SQLModel 点星

你可以在 GitHub 上为 SQLModel “点星”(点击右上角的星标按钮):https://github.com/fastapi/sqlmodel。⭐️

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

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

你可以在 GitHub 上“关注” SQLModel(点击右上角的“watch”按钮):https://github.com/fastapi/sqlmodel。👀

在那里你可以选择“仅限发布(Releases only)”。

通过这样做,你将在 SQLModel 发布新版本(包含 bug 修复和新特性)时收到通知(通过电子邮件)。

与作者联系

你可以与我(Sebastián Ramírez / tiangolo),即作者联系。

你可以

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

发布关于 SQLModel 的推文

发布关于 SQLModel 的推文,让我和大家知道你为什么喜欢它。🎉

我喜欢听大家分享 SQLModel 的使用情况、你喜欢它的哪些地方、你在哪个项目/公司中使用它等等。

在 GitHub 上帮助他人解决问题

你可以尝试帮助他人在以下地方解决问题

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

请记住,最重要的一点是:尽量保持友善。人们带着沮丧而来,在许多情况下,提问的方式可能不是最好的,但请尽力保持友善。🤗

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


以下是如何帮助他人解决问题(在讨论或议题中)

理解问题

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

  • 然后检查问题(绝大多数是问题)是否清晰

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

  • 如果你不理解问题,请要求提供更多细节

重现问题

对于大多数情况和大多数问题,都与提问者的原始代码有关。

在许多情况下,他们只会复制代码片段,但这不足以重现问题

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

  • 如果你觉得自己太慷慨了,你可以尝试根据问题的描述自己创建这样一个示例。请记住,这可能需要大量时间,最好先请他们澄清问题。

提出解决方案

  • 在能够理解问题后,你可以给他们一个可能的答案

  • 在许多情况下,更好地理解他们的潜在问题或用例会更好,因为可能存在比他们正在尝试做的更好的解决方案。

请求关闭

如果他们回复,你很有可能已经解决了他们的问题,恭喜,你是一个英雄!🦸

  • 现在,如果这解决了他们的问题,你可以要求他们

    • 在 GitHub Discussions 中:将评论标记为答案
    • 在 GitHub Issues 中:关闭该 issue。

关注 GitHub 仓库

你可以在 GitHub 上“关注” SQLModel(点击右上角的“watch”按钮):https://github.com/fastapi/sqlmodel。👀

如果你选择“Watching”而不是“Releases only”,当有人创建新的 issue 或问题时,你将收到通知。你还可以指定只希望收到关于新 issue、讨论或 PR 等的通知。

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

提问

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

  • 提出一个问题或关于一个问题的疑问。
  • 建议一个新功能

注意:如果你这样做,我也会要求你帮助其他人。😉

审查拉取请求

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

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


以下是审查拉取请求时需要记住的事项和方法

理解问题

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

  • 也有很大的可能性,该拉取请求实际上并不需要,因为问题可以通过其他方式解决。然后你可以提出或询问相关问题。

不用担心风格

  • 不用太担心提交消息风格之类的事情,我会手动定制提交并进行压缩合并。

  • 也不用担心风格规则,已经有自动化工具在检查这些了。

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

检查代码

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

  • 然后评论说你已经这样做了,这样我就知道你确实检查过了。

信息

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

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

所以,你实际阅读并运行代码,并在评论中告诉我你已经这样做了,这非常重要。🤓

  • 如果 PR 可以某种方式简化,你可以提出,但不必过于挑剔,可能有很多主观的观点(我也会有自己的观点🙈),所以最好关注根本性的问题。

测试

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

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

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

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

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

创建拉取请求

你可以通过拉取请求为源代码贡献,例如

  • 修正你在文档中发现的错别字。
  • 提出新的文档部分。
  • 修复现有问题/错误。
    • 确保添加测试。
  • 添加新功能。
    • 确保添加测试。
    • 如果相关,请确保添加文档。

帮助维护 SQLModel

帮助我维护 SQLModel!🤓

有很多工作要做,其中大部分,都可以做。

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

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

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

加入聊天

加入 👥 FastAPI and Friends Discord 聊天服务器 👥,与社区中的其他人交流。有一个 #sqlmodel 频道。

提示

对于问题,请在GitHub Discussions中提出,在那里你更有可能获得帮助。

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

不要使用聊天来提问

请记住,由于聊天允许更“自由的对话”,很容易提出过于笼统且难以回答的问题,因此,你可能无法获得答案。

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

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

另一方面,聊天中有成千上万的用户,所以你很有可能在几乎任何时候都能找到人聊天。😄

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

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

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

你也可以资助


谢谢!🚀