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