帮助 FastAPI - 获取帮助¶
你喜欢 FastAPI 吗?
你想帮助 FastAPI、其他用户和作者吗?
或者,你想在使用 FastAPI 时获得帮助?
有一些非常简单的方法可以提供帮助(有些只需要点击一两下)。
同时也有多种获取帮助的方式。
订阅邮件通讯¶
您可以订阅(不频繁的)FastAPI and friends 邮件通讯以获取最新动态:
- 关于 FastAPI and friends 的新闻 🚀
- 指南 📝
- 功能 ✨
- 重大变更 🚨
- 技巧和诀窍 ✅
在 X (Twitter) 上关注 FastAPI¶
在 X (Twitter) 上关注 @fastapi 以获取关于 FastAPI 的最新消息。🐦
在 GitHub 上 Star FastAPI¶
你可以在 GitHub 上为 FastAPI “star”(点击右上角的 star 按钮):https://github.com/fastapi/fastapi。⭐️
通过 star,其他用户能更容易地发现它,并了解到它已经对其他人很有用。
Watch GitHub 仓库以获取版本发布信息¶
你可以在 GitHub 上 “watch” 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 社区成为一个友善和热情的社区。同时,不接受欺凌或对他人的不尊重行为。我们必须互相照顾。
以下是如何在(Discussions 或 Issues 中)帮助他人解决问题的方法:
理解问题¶
-
检查你是否能理解提问者的目的和使用场景。
-
然后检查问题(绝大多数都是问题)是否清晰。
-
在很多情况下,提问者问的是一个他们自己设想的解决方案,但可能有一个更好的方案。如果你能更好地理解问题和使用场景,你或许可以提出一个更好的替代解决方案。
-
如果你无法理解问题,请要求提供更多细节。
复现问题¶
在大多数情况下,大部分问题都与提问者的原始代码有关。
很多时候,他们只会复制部分代码片段,但这不足以复现问题。
-
你可以要求他们提供一个最小可复现示例,你可以复制粘贴并在本地运行,以看到和他们一样的错误或行为,或者更好地理解他们的使用场景。
-
如果你非常乐于助人,你可以尝试自己根据问题描述来创建一个示例。但请记住,这可能需要很多时间,最好还是先请他们澄清问题。
提出解决方案¶
-
在能够理解问题之后,你可以给他们一个可能的答案。
-
在很多情况下,更好地理解他们潜在的问题或使用场景是很重要的,因为可能有比他们正在尝试的更好的解决方法。
请求关闭¶
如果他们回复了,你很有可能已经解决了他们的问题,恭喜你,你是英雄!🦸
-
现在,如果问题解决了,你可以请求他们:
- 在 GitHub Discussions 中:将评论标记为答案。
- 在 GitHub Issues 中:关闭该 issue。
Watch GitHub 仓库¶
你可以在 GitHub 上 “watch” FastAPI(点击右上角的 “watch” 按钮):https://github.com/fastapi/fastapi。👀
如果你选择 “Watching” 而不是 “Releases only”,当有人创建新的 issue 或问题时,你就会收到通知。你也可以指定只接收新 issue、discussions 或 PRs 等的通知。
然后,你就可以尝试帮助他们解决这些问题。
提出问题¶
你可以在 GitHub 仓库中创建一个新问题,例如:
- 提出一个问题或询问一个难题。
- 建议一个新功能。
注意:如果你这样做,我也会请你帮助其他人。😉
审查拉取请求¶
你可以帮助我审查其他人的拉取请求。
再次强调,请尽你所能保持友善。🤗
以下是审查拉取请求时需要注意的事项和方法:
理解问题¶
-
首先,确保你理解该拉取请求试图解决的问题。它可能在 GitHub Discussion 或 issue 中有更长的讨论。
-
也很有可能这个拉取请求实际上并不需要,因为问题可以用不同的方式解决。这时你可以提出建议或询问相关情况。
不必担心代码风格¶
-
不用太担心提交信息的风格等问题,我会手动 squash and merge 并自定义提交信息。
-
也不用担心代码风格规则,已经有自动化工具在检查这些了。
如果还有其他风格或一致性的需求,我会直接提出,或者我会在上面添加提交来进行必要的修改。
检查代码¶
-
检查并阅读代码,看看它是否合理,在本地运行它,看看它是否真的解决了问题。
-
然后评论说你已经这样做了,这样我才能知道你真的检查过了。
信息
很遗憾,我不能简单地信任那些只有几个批准的 PR。
有好几次,有些 PR 有 3、5 个甚至更多的批准,可能是因为描述很吸引人,但当我检查这些 PR 时,它们实际上是有问题的、有 bug,或者并没有解决它们声称要解决的问题。😅
所以,你实际阅读并运行代码,并在评论中告诉我你这样做了,这一点非常重要。🤓
- 如果 PR 可以以某种方式简化,你可以要求这样做,但不必过于挑剔,可能有很多主观看法(我也会有我自己的看法 🙈),所以最好专注于基本的东西。
测试¶
-
帮助我检查 PR 是否有测试。
-
检查测试在 PR 之前是否失败。🚨
-
然后检查测试在 PR 之后是否通过。✅
-
许多 PR 没有测试,你可以提醒他们添加测试,或者你甚至可以自己建议一些测试。这是最耗时的事情之一,你在这方面可以帮上大忙。
-
然后还要评论你尝试了什么,这样我就会知道你检查过了。🤓
创建拉取请求¶
你可以通过拉取请求为源代码做出贡献,例如:
- 修正你在文档中发现的拼写错误。
- 通过编辑此文件,分享你创建或发现的关于 FastAPI 的文章、视频或播客。
- 确保你将链接添加到相应部分的开头。
- 帮助将文档翻译成你的语言。
- 你也可以帮助审查他人创建的翻译。
- 提出新的文档章节。
- 修复现有的 issue/bug。
- 确保添加测试。
- 添加新功能。
- 确保添加测试。
- 如果相关,确保添加文档。
帮助维护 FastAPI¶
帮助我维护 FastAPI!🤓
有很多工作要做,而其中大部分工作,你都可以做。
你现在可以做的主要任务是:
- 在 GitHub 上帮助他人解决问题(见上文)。
- 审查拉取请求(见上文)。
这两项任务是最耗时的。这是维护 FastAPI 的主要工作。
如果你能在这方面帮助我,你就是在帮助我维护 FastAPI,并确保它能更快更好地发展。🚀
加入聊天¶
加入 👥 Discord 聊天服务器 👥,与 FastAPI 社区的其他人一起交流。
不要在聊天中提问¶
请记住,由于聊天允许更“自由的对话”,很容易提出过于宽泛且难以回答的问题,所以你可能得不到答案。
在 GitHub 中,模板会引导你写出正确的问题,以便你更容易得到好的答案,甚至在提问前自己解决问题。而在 GitHub 中,我可以确保我总是回答所有问题,即使需要一些时间。我个人无法在聊天系统中做到这一点。😅
聊天系统中的对话也不如 GitHub 中那样容易搜索,所以问题和答案可能会在对话中丢失。而且只有 GitHub 中的贡献才能计入成为 FastAPI 专家的资格,所以你很可能在 GitHub 上得到更多的关注。
另一方面,聊天系统中有成千上万的用户,所以你很有可能在那里随时找到人聊天。😄
赞助作者¶
如果你的产品/公司依赖或与 FastAPI 相关,并且你想触达其用户,你可以通过 GitHub sponsors 赞助作者(我)。根据不同的赞助等级,你可能会获得一些额外的好处,比如在文档中获得一个徽章。🎁
谢谢!🚀