帮助 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。👀
在那里您可以选择“仅发布版本”。
这样做,每当有新的 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 Discussion 或 issue 中有更长的讨论。
-
也有很大的可能性,拉取请求实际上并不需要,因为问题可以通过不同的方式解决。然后您可以提出或询问这个问题。
不用担心风格¶
-
不用太担心诸如提交信息样式之类的事情,我会手动压缩和合并,并自定义提交信息。
-
也不用担心样式规则,已经有自动化工具在检查这些了。
如果还有其他样式或一致性需求,我会直接要求,或者我会在顶部添加提交来包含所需的更改。
检查代码¶
-
检查并阅读代码,看看它是否有意义,在本地运行它并看看它是否真的解决了问题。
-
然后评论说您已完成此操作,这样我就会知道您确实检查过了。
信息
不幸的是,我不能简单地信任那些只有几个审批的 PR。
多次发生过这样的情况:有些 PR 有 3、5 个或更多的审批,可能是因为描述很吸引人,但当我检查 PR 时,它们实际上是损坏的、有 bug,或者没有解决它们声称要解决的问题。😅
所以,您真正阅读并运行代码,并在评论中告诉我您这样做了,这非常重要。🤓
- 如果拉取请求可以以某种方式简化,您可以提出要求,但不必过于挑剔,可能有很多主观观点(我也会有我自己的🙈),所以最好关注根本性的问题。
测试¶
-
帮我检查拉取请求是否包含测试。
-
检查测试在拉取请求之前是否失败。🚨
-
然后检查测试在拉取请求之后是否通过。✅
-
许多 PR 没有测试,您可以提醒他们添加测试,甚至可以自己建议一些测试。这是最耗时的事情之一,在这方面您可以提供很多帮助。
-
然后也评论您尝试了什么,这样我就知道您检查过了。🤓
创建拉取请求¶
您可以通过拉取请求贡献源代码,例如:
- 修复您在文档中发现的拼写错误。
- 通过编辑此文件分享您创建或找到的关于 FastAPI 的文章、视频或播客。
- 请确保将您的链接添加到相应部分的开头。
- 帮助将文档翻译成您的语言。
- 您还可以帮助审查其他人创建的翻译。
- 提出新的文档章节。
- 修复现有问题/错误。
- 务必添加测试。
- 添加新功能。
- 务必添加测试。
- 如果相关,务必添加文档。
帮助维护 FastAPI¶
帮我维护 FastAPI!🤓
有很多工作要做,其中大部分,你都可以做。
您现在可以做主要任务是:
- 在 GitHub 上帮助他人解决问题(参见上文)。
- 审查拉取请求(参见上文)。
这两个任务是最耗时的。这是维护 FastAPI 的主要工作。
如果您能在这方面帮助我,您就是在帮助我维护 FastAPI,并确保它能更快更好地发展。🚀
加入聊天¶
加入 👥 Discord 聊天服务器 👥,与 FastAPI 社区的其他人交流。
请勿将聊天用于提问¶
请记住,由于聊天允许更“自由的对话”,所以很容易提出过于宽泛且难以回答的问题,因此您可能无法收到答案。
在 GitHub 中,模板将指导您编写正确的问题,以便您更容易获得好的答案,甚至在提问之前就自己解决问题。在 GitHub 中,我可以确保我总是回答所有问题,即使需要一些时间。我无法亲自在聊天系统中做到这一点。😅
聊天系统中的对话也不像 GitHub 中那样容易搜索,因此问题和答案可能会在对话中丢失。只有 GitHub 中的内容才算作成为 FastAPI 专家的依据,因此您很可能会在 GitHub 中获得更多关注。
另一方面,聊天系统中有成千上万的用户,所以您几乎总能找到人聊天。😄
赞助作者¶
如果您的产品/公司依赖或与 FastAPI 相关,并且您想接触其用户,您可以通过 GitHub 赞助商赞助作者(我)。根据不同的级别,您可以获得一些额外的好处,例如在文档中获得徽章。🎁
谢谢!🚀