帮助 FastAPI - 获取帮助¶
你喜欢 FastAPI 吗？
你想帮助 FastAPI、其他用户和作者吗？
或者你想获取关于 FastAPI 的帮助？
有很多简单的方式可以提供帮助（其中一些只需点击一两次）。
同时也有多种获取帮助的方式。
订阅新闻通讯¶
你可以订阅（不频繁的）FastAPI 和朋友 新闻通讯，以获取以下最新信息：
- FastAPI 和朋友的相关新闻 🚀
- 指南 📝
- 新功能 ✨
- 重大变更 🚨
- 提示和技巧 ✅
在 X (Twitter) 上关注 FastAPI¶
在 X (Twitter) 上关注 @fastapi，获取关于 FastAPI 的最新新闻。🐦
在 GitHub 上给 FastAPI 加星标¶
你可以在 GitHub 上给 FastAPI 加“星标”（点击右上角的星标按钮）：https://github.com/fastapi/fastapi。⭐️
通过添加星标，其他用户可以更容易地找到它，并看到它已经对其他人有用。
关注 GitHub 仓库以获取发布信息¶
你可以在 GitHub 上“关注” FastAPI（点击右上角的“watch”按钮）：https://github.com/fastapi/fastapi。👀
在那里你可以选择“仅发布（Releases only）”。
这样操作后，每当有 FastAPI 的新版本（包含错误修复和新功能）发布时，你将收到通知（通过电子邮件）。
与作者联系¶
你可以与我（Sebastián Ramírez / tiangolo），即作者，取得联系。
你可以：
- 在 GitHub 上关注我。
- 查看我创建的其他可能对你有帮助的开源项目。
- 关注我以在我创建新的开源项目时获得通知。
- 在 X (Twitter) 上关注我 或 Mastodon。
- 告诉我你是如何使用 FastAPI 的（我很乐意听这个）。
- 在我发布公告或新工具时获得消息。
- 你也可以 在 X (Twitter) 上关注 @fastapi（一个单独的账号）。
- 在 LinkedIn 上关注我。
- 在我发布公告或新工具时获得消息（虽然我更常使用 X (Twitter) 🤷♂)。
- 在 Dev.to 或 Medium 上阅读我写的内容（或关注我）。
- 阅读其他想法、文章，并了解我创建的工具。
- 关注我，以便在我发布新内容时阅读。
发推文介绍 FastAPI¶
发推文介绍 FastAPI，让我和其他人知道你为什么喜欢它。🎉
我很乐意听到 FastAPI 是如何被使用的，你喜欢它的哪些方面，你在哪个项目/公司使用它等等。
为 FastAPI 投票¶
在 GitHub 上帮助他人解决问题¶
你可以尝试在以下地方帮助他人解决问题：
在很多情况下，你可能已经知道这些问题的答案。🤓
如果你帮助很多人解决了他们的问题，你将成为官方的 FastAPI 专家。🎉
请记住，最重要的一点是：尽量保持友善。人们带着他们的挫败感而来，很多时候提问的方式并不完美，但请尽你所能保持友善。🤗
我们的目标是让 FastAPI 社区变得友善和受欢迎。同时，不要接受欺凌或不尊重他人的行为。我们必须互相照顾。
以下是如何在讨论或议题中帮助他人解决问题的方法：
理解问题¶
-
检查你是否能理解提问者的目的和使用场景。
-
然后检查问题（绝大多数是问题）是否清晰。
-
在很多情况下，用户提问的是他们想象中的解决方案，但可能有一个更好的解决方案。如果你能更好地理解问题和用例，你也许能建议一个更好的替代解决方案。
-
如果你不理解问题，请要求提供更多细节。
复现问题¶
对于大多数情况和大多数问题，都与提问者的原始代码有关。
在很多情况下，他们只会复制代码片段，但这不足以复现问题。
-
你可以要求他们提供一个 最小可复现示例，这样你可以复制粘贴并在本地运行，以看到相同的错误或行为，或者更好地理解他们的用例。
-
如果你非常热心，你可以尝试根据问题的描述自己创建这样一个示例。只是请记住，这可能会花费很多时间，最好先请他们澄清问题。
建议解决方案¶
-
在能够理解问题之后，你可以给他们一个可能的答案。
-
在很多情况下，最好理解他们的根本问题或用例，因为可能有比他们尝试的方法更好的解决方式。
请求关闭¶
如果他们回复了，很有可能你已经解决了他们的问题，恭喜你，你是英雄！🦸
-
现在，如果那解决了他们的问题，你可以请他们：
- 在 GitHub Discussions 中：将该评论标记为答案。
- 在 GitHub Issues 中：关闭该议题。
关注 GitHub 仓库¶
你可以在 GitHub 上“关注” FastAPI（点击右上角的“watch”按钮）：https://github.com/fastapi/fastapi。👀
如果你选择“Watching”而不是“Releases only”，当有人创建新议题或问题时，你会收到通知。你也可以指定只接收关于新议题、讨论或拉取请求等的通知。
然后你可以尝试帮助他们解决这些问题。
提问¶
你可以在 GitHub 仓库中 创建一个新问题，例如：
- 提出一个问题或询问一个问题。
- 建议一个新的功能。
注意：如果你这样做，那么我会要求你也帮助其他人。😉
审查拉取请求¶
你可以帮助我审查来自他人的拉取请求。
再次提醒，请尽最大努力保持友善。🤗
以下是审查拉取请求时需要记住的要点和方法：
理解问题¶
-
首先，确保你理解拉取请求试图解决的问题。它可能在 GitHub 讨论或议题中有更长的讨论。
-
也有可能这个拉取请求实际上并不需要，因为问题可以用不同的方式解决。那么你可以建议或询问这一点。
不必担心样式¶
-
不必太担心诸如提交消息样式之类的事情，我会在合并时压缩提交并手动自定义提交信息。
-
也不必担心样式规则，已经有自动化工具检查这些。
如果有任何其他样式或一致性需求，我会直接要求，或者我会在顶部添加包含所需更改的提交。
检查代码¶
-
检查并阅读代码，看它是否有意义，在本地运行它，看看它是否真的解决了问题。
-
然后评论说明你做了这些，这样我就知道你确实检查过了。
Info
不幸的是，我不能简单地信任那些只有几个批准的 PR。
有好几次，有些 PR 有 3 个、5 个或更多的批准，可能是因为描述很吸引人，但当我检查这些 PR 时，它们实际上是坏的、有错误，或者没有解决它们声称要解决的问题。😅
所以，非常重要的一点是，你确实阅读并运行了代码，并在评论中告诉我你做了。🤓
- 如果 PR 可以以某种方式简化，你可以要求这样做，但不需要太挑剔，可能有很多主观的观点（我也会有我自己的观点 🙈），所以你最好能关注基本的东西。
测试¶
-
帮助我检查 PR 是否有测试。
-
检查在 PR 之前测试是否失败。🚨
-
然后检查在 PR 之后测试是否通过。✅
-
许多 PR 没有测试，你可以提醒他们添加测试，或者你甚至可以建议一些测试。这是最耗时的事情之一，你可以在这方面提供很大帮助。
-
然后也评论你尝试了什么，这样我就知道你检查过了。🤓
创建拉取请求¶
你可以通过拉取请求贡献源代码，例如：
- 修复你在文档中发现的拼写错误。
- 通过编辑此文件，分享你创建或找到的关于 FastAPI 的文章、视频或播客。
- 确保将你的链接添加到相应部分的开头。
- 帮助将文档翻译成你的语言。
- 你也可以帮助审查他人创建的翻译。
- 提议新的文档部分。
- 修复现有的问题/错误。
- 确保添加测试。
- 添加新功能。
- 确保添加测试。
- 如果相关，确保添加文档。
帮助维护 FastAPI¶
帮助我维护 FastAPI！🤓
有很多工作要做，而其中大部分工作你都可以做。
你现在可以做的主要任务是：
- 在 GitHub 上帮助他人解决问题（参见上文）。
- 审查拉取请求（参见上文）。
这两项任务是最耗时的。这是维护 FastAPI 的主要工作。
如果你能在这方面帮助我，你就是在帮助我维护 FastAPI，并确保它更快更好地发展。🚀
加入聊天¶
加入 👥 Discord 聊天服务器 👥，与 FastAPI 社区中的其他人一起交流。
不要使用聊天来提问¶
请记住，由于聊天允许更“自由的对话”，很容易提出过于笼统且更难回答的问题，因此，你可能不会收到答案。
在 GitHub 上，模板会引导你写出正确的问题，以便你更容易得到好的答案，甚至在提问前自己解决问题。而且在 GitHub 上，我可以确保我总是回答所有问题，即使需要一些时间。我个人无法在聊天系统中做到这一点。😅
聊天系统中的对话也不像在 GitHub 中那样易于搜索，因此问题和答案可能会在对话中丢失。并且只有 GitHub 中的对话才会计入成为 FastAPI 专家，所以你很可能在 GitHub 上获得更多关注。
另一方面，聊天系统中有成千上万的用户，所以你很有可能在那里找到人交谈，几乎任何时候都可以。😄
赞助作者¶
如果你的产品/公司依赖或与 FastAPI 相关，并且你想接触其用户，你可以通过 GitHub 赞助者赞助作者（我）。根据赞助等级，你可能会获得一些额外的好处，例如文档中的徽章。🎁
谢谢！🚀