帮助 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。
- 阅读我写的其他文章和关于我创建的工具。
- 关注我,阅读我发布的新内容。
在 Twitter 上发布关于 SQLModel 的推文¶
发布关于 SQLModel 的推文,让我和其他人知道你喜欢它的原因。 🎉
我喜欢听到 SQLModel 是如何被使用的,哪些方面你觉得很棒,在哪个项目/公司使用它,等等。
在 GitHub 上帮助其他人解答问题¶
你可以尝试帮助其他人在以下平台解决问题:
在很多情况下,你可能已经知道这些问题的答案。 🤓
只要记住,最重要的一点是:尽量保持友善。人们带着他们的困惑和不满提问,很多时候问题提得不够清晰,但尽可能友好地回应他们。🤗
我们的目标是让 SQLModel 社区变得友好和欢迎。同时,不接受任何针对他人的恶意或不尊重的行为。我们必须彼此照顾。
以下是如何帮助他人解决问题(在讨论或问题中):
理解问题¶
- 确认你是否能理解提问者的 目的 和使用场景。
- 然后确认问题(大多数情况下是问题)是否 清晰。
- 在许多情况下,提问的问题基于用户设想的某种解决方案,但可能有一个 更好的 解决方案。如果你能更好地理解问题和使用场景,可能能提出一个更合适的 替代解决方案。
- 如果你无法理解问题,可以要求提供更多的 细节。
复现问题¶
对于大多数问题和问题来说,都涉及到提问者的 原始代码。
很多时候,他们只会复制代码的片段,但那样不足以 复现问题。
- 你可以要求他们提供一个 最小可复现示例,这样你就可以 复制粘贴 并在本地运行,查看他们遇到的错误或行为,或者更好地理解他们的使用场景。
- 如果你有时间和耐心,可以根据问题的描述自己尝试 创建示例。但要记住,这可能会花费很多时间,最好先请他们澄清问题。
提供解决方案¶
-
在理解了问题之后,你可以给出一个可能的 答案。
-
在许多情况下,更好的是理解他们的 根本问题或使用场景,因为可能有比他们尝试的方式更好的解决方案。
请求关闭¶
如果他们回复,很可能你已经解决了他们的问题,恭喜你,你是个英雄!🦸
-
现在,如果这解决了他们的问题,你可以要求他们:
- 在 GitHub Discussions 中:标记评论为 答案。
- 在 GitHub Issues 中:关闭 该问题。
关注 GitHub 仓库¶
你可以在 GitHub 上“关注”SQLModel(点击右上角的“关注”按钮): https://github.com/fastapi/sqlmodel。👀
如果你选择“Watching”(而非“仅发布”),你将收到通知,当有人创建新问题或提问时。你还可以选择只接收新问题、讨论或 PR 等的通知。
然后你可以尝试帮助他们解决这些问题。
提问¶
你可以在 GitHub 仓库中 创建一个新问题,例如:
- 提问 问题 或询问关于 问题 的内容。
- 提议一个新的 功能。
注意:如果你这么做,我会要求你也帮助其他人。😉
审查 Pull 请求¶
你可以帮助我审查其他人的 Pull 请求。
同样,请尽量保持友好。🤗
以下是审查 Pull 请求时需要注意的事项:
理解问题¶
-
首先,确保你 理解 这个 Pull 请求试图解决的问题。可能会在 GitHub Discussions 或 Issue 中有更详细的讨论。
-
也有可能这个 Pull 请求实际上不需要,因为问题可以用 不同的方式 解决。然后你可以提出建议或询问关于其他解决方案的意见。
不要过于关注样式¶
-
不用太担心像提交信息样式这样的细节,我会在合并时手动调整提交记录。
-
同样,不用担心样式规则,已经有自动化工具在检查这些问题。
如果有其他样式或一致性方面的需求,我会直接提出,或者在现有提交上添加修改。
检查代码¶
-
检查并阅读代码,看看是否合适,本地运行 看是否真正解决了问题。
-
然后 评论 说明你已经这样做了,这样我会知道你确实检查过。
Info
不幸的是,我不能仅凭几个批准就轻易信任 PR。
有时会发生 PR 已经获得 3、5 个或更多的批准,可能因为描述吸引人,但当我检查 PR 时,实际上它们是坏的、存在漏洞,或者没有解决它们声称要解决的问题。😅
因此,真的很重要的是,你要实际阅读并运行代码,并在评论中告诉我你已经检查过。🤓
- 如果 PR 可以简化,你可以提出请求,但不必过于挑剔,可能会有许多主观的观点(而我也会有自己的观点 🙈),所以最好能关注核心内容。
测试¶
-
帮我检查 PR 是否包含 测试。
-
检查测试是否在 PR 之前 失败。🚨
-
然后检查测试是否在 PR 后 通过。✅
-
许多 PR 没有测试,你可以 提醒 他们添加测试,或者你甚至可以 自己建议 一些测试。这是耗时最多的任务之一,你可以提供很多帮助。
-
然后也评论你尝试的内容,这样我就知道你检查过了。🤓
创建 Pull 请求¶
你可以通过 Pull 请求 贡献 源代码,例如:
- 修复文档中发现的拼写错误。
- 提议新的文档部分。
- 修复现有的缺陷/错误。
- 确保添加测试。
- 添加新功能。
- 确保添加测试。
- 确保添加相关文档。
帮助维护 SQLModel¶
帮我维护 SQLModel!🤓
有很多工作要做,而且对于大多数工作,你 可以做。
你现在可以做的主要任务是:
- 帮助他人在 GitHub 上解答问题(见上面的部分)。
- 审查 Pull 请求(见上面的部分)。
这两项任务是 最耗时的。这也是维护 SQLModel 的主要工作。
如果你能帮我做这些,你就在帮助我维护 SQLModel,并确保它继续 快速而有效地发展。🚀
加入聊天¶
加入 👥 FastAPI 和朋友 Discord 聊天服务器 👥,和社区中的其他人一起聊天。在其中有一个 #sqlmodel
频道。
不要在聊天中提问¶
请记住,由于聊天允许更多“自由对话”,很容易提问过于广泛的问题,这些问题可能不容易回答,所以你可能不会得到答案。
在 GitHub 中,模板会引导你写出正确的问题,这样你可以更容易获得好的答案,或者甚至在提问之前就解决问题。而在聊天中,我无法保证我一定会答复每一个问题,即使有时会花一些时间。😅
在 GitHub 中,所有对话都可以很容易地被搜索,而聊天中的对话不易搜索,所以问题和答案可能会在对话中丢失。
另一方面,聊天中有成千上万的用户,所以几乎每次你都能找到人交流。😄
支持作者¶
你也可以通过 GitHub Sponsors 经济支持作者(我)。
在这里,你可以请我喝杯咖啡 ☕️ 以表达感谢。😄
支持 SQLModel 所依赖的工具¶
正如你在文档中看到的,SQLModel 建立在 Pydantic 和 SQLAlchemy 这些巨人的肩膀上。
你也可以支持:
感谢!🚀