跳至內容

協助 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 上追蹤我.
    • 查看我建立的其他可能對您有幫助的開源專案。
    • 追蹤我以了解我何時建立新的開源專案。
  • TwitterMastodon 上追蹤我。
    • 告訴我您是如何使用 FastAPI 的(我很樂意聽到)。
    • 在我發布公告或新工具時收到通知。
    • 您也可以在 Twitter 上追蹤 @fastapi(一個獨立的帳號)。
  • LinkedIn 上追蹤我.
    • 在我發布公告或新工具時收到通知(雖然我更常使用 Twitter 🤷‍♂)。
  • 閱讀我在 Dev.toMedium 上的文章(或追蹤我)。
    • 閱讀其他想法、文章,並了解我建立的工具。
    • 追蹤我以便在我發布新內容時閱讀。

在 Twitter 上發推文談論 FastAPI

在 Twitter 上發推文談談你對 FastAPI 的喜愛,讓我和其他人知道你喜歡它的原因吧!🎉

我很想聽聽 FastAPI 的使用案例、你喜歡它的哪些方面、你在哪個專案/公司使用它等等。

為 FastAPI 投票

在 GitHub 上協助解答問題

你可以嘗試在以下地方協助解答其他人的問題:

在很多情況下,你可能已經知道這些問題的答案。🤓

如果你協助許多人解決了問題,你將成為官方的 FastAPI 專家。🎉

請記住,最重要的一點是:盡量友善。提問者可能帶著挫折感,很多時候提問的方式並不理想,但請盡你所能地保持友善。🤗

FastAPI 社群的理念是友善和包容。同時,也不接受霸凌或對他人不尊重的行為。我們必須互相照顧。


以下是如何協助解答他人問題的方法(在討論區或問題回報中):

理解問題

  • 確認你能理解提問者的目的和使用案例。

  • 接著確認問題(絕大多數都是問題)是否清楚

  • 很多時候,提問的問題是關於使用者想像的解決方案,但可能會有更好的解決方案。如果你能更好地理解問題和使用案例,你或許可以建議一個更好的替代方案

  • 如果你無法理解問題,請要求提供更多細節

重現問題

在大多數情況和大多數問題中,都與提問者的原始程式碼有關。

很多時候,他們只會複製程式碼片段,但这不足以重現問題

  • 你可以請他們提供一個最小可重現範例,以便你可以複製貼上並在本地執行,以查看他們看到的相同錯誤或行為,或者更好地理解他們的使用案例。

  • 如果你覺得自己非常慷慨,你可以嘗試僅根據問題描述自行建立一個這樣的範例。但請記住,這可能需要很多時間,最好先請他們釐清問題。

建議解決方案

  • 在理解問題後,你可以給他們一個可能的答案

  • 很多時候,最好理解他們潛在的問題或使用案例,因為可能有比他們正在嘗試的方法更好的解決方法。

要求關閉問題

如果他們回覆了,很有可能你已經解決了他們的問題,恭喜,你是個英雄!🦸

  • 現在,如果問題已經解決,你可以請他們:

    • 在 GitHub 討論區:將評論標記為答案
    • 在 GitHub Issues 中:**關閉** issue。

關注 GitHub 儲存庫

您可以在 GitHub 上「關注」FastAPI(點擊右上角的「關注」按鈕):https://github.com/fastapi/fastapi。 👀

如果您選擇「關注」而不是「僅限發佈」,您將會在有人建立新的 issue 或問題時收到通知。您也可以指定只接收關於新 issue、討論或 PR 等的通知。

然後您可以嘗試幫助他們解決這些問題。

提問

您可以在 GitHub 儲存庫中建立新的問題,例如:

  • 提出**問題**或詢問**遇到的困難**。
  • 建議新的**功能**。

**注意**:如果您這樣做,我會請您也幫助其他人。 😉

審查 Pull Request(PR)

您可以協助我審查其他人的 PR。

再次提醒,請盡力保持友善。 🤗


以下是審查 PR 時需要注意的事項和方法

理解問題

  • 首先,請確保您**理解 PR 嘗試解決的問題**。它可能在 GitHub 討論區或 issue 中有更長的討論。

  • 也有可能這個 PR 實際上並不需要,因為問題可以**用其他方式解決**。您可以提出建議或詢問相關問題。

不用擔心程式碼風格

  • 不用太擔心程式碼提交訊息的風格,我會手動壓縮合併並自訂提交訊息。

  • 也不用擔心程式碼風格規則,已經有自動化工具會檢查這些。

如果還有其他風格或一致性需求,我會直接提出要求,或者我會在上面新增提交以進行必要的更改。

檢查程式碼

  • 檢查並閱讀程式碼,看看它是否合理,**在本地端執行**,看看它是否真的解決了問題。

  • 然後**留言**說明您已完成這些步驟,這樣我就知道您確實檢查過了。

資訊

很遺憾,我不能完全信任僅獲得多次批准的 PR。

曾發生過多次有 3、5 個或更多人批准的 PR,可能是因為描述很吸引人,但當我檢查這些 PR 時,它們實際上是壞掉的、有錯誤的,或者沒有解決它們聲稱要解決的問題。 😅

所以,您實際閱讀並執行程式碼,並在留言中告知我您已完成這些步驟,這一點非常重要。 🤓

  • 如果 PR 可以簡化的話,您可以提出要求,但不需要太挑剔,可能有很多主觀的觀點(我也有我自己的觀點 🙈),所以最好能專注於基本的事情。

測試

  • 請協助我確認 PR 是否包含**測試**。

  • 確認測試在 PR 之前是**失敗的**。 🚨

  • 然後確認測試在 PR 之後是**通過的**。 ✅

  • 許多 PR 沒有測試,您可以**提醒**他們新增測試,或者您甚至可以自己**建議**一些測試。這是最耗時的事情之一,您可以在這方面提供很大的幫助。

  • 然後也請留言說明您嘗試的內容,這樣我就知道您已檢查過。 🤓

建立 Pull Request

您可以透過提交 Pull Request 來貢獻原始碼,例如:

  • 修正您在文件中發現的錯字。
  • 透過編輯此檔案來分享您創作或找到的關於 FastAPI 的文章、影片或播客。
    • 請確保您將連結添加到對應章節的開頭。
  • 協助將文件翻譯成您的語言。
    • 您也可以協助審閱其他人建立的翻譯。
  • 提出新的文件章節。
  • 修復現有的問題/錯誤。
    • 請務必添加測試。
  • 添加新功能。
    • 請務必添加測試。
    • 如果相關,請務必添加文件。

協助維護 FastAPI

協助我維護 FastAPI!🤓

有很多工作要做,而且大部分的工作,都可以做。

您現在可以做的主要任務是

這兩項任務是最耗費時間的。這是維護 FastAPI 的主要工作。

如果您能在這方面幫助我,您就是在幫助我維護 FastAPI,並確保它能持續更快、更好地發展。🚀

加入聊天

加入 👥 Discord 聊天伺服器 👥 並與 FastAPI 社群中的其他人交流。

提示

如有問題,請在 GitHub Discussions 中提問,您更有機會獲得 FastAPI 專家 的協助。

聊天僅用於其他一般對話。

不要在聊天中提問

請記住,由於聊天允許更「自由的對話」,很容易提出過於籠統且難以回答的問題,因此您可能得不到答案。

在 GitHub 中,範本會引導您撰寫正確的問題,以便您更容易獲得好的答案,甚至在提問之前就能自行解決問題。在 GitHub 中,我可以確保我會回答所有問題,即使需要一些時間。我個人無法在聊天系統中做到這一點。😅

聊天系統中的對話也不像 GitHub 中那樣容易搜尋,因此問題和答案可能會在對話中遺失。而且只有在 GitHub 中的提問才算成為 FastAPI 專家 的條件,因此您在 GitHub 中可能會獲得更多關注。

另一方面,聊天系統中有數千名用戶,因此您很有可能在那裡找到可以交談的人,幾乎隨時都可以。 😄

您也可以透過 GitHub 贊助 在財務上支持作者(我)。

在那裡您可以請我喝杯咖啡 ☕️ 表示感謝。😄

您也可以成為 FastAPI 的銀級或金級贊助商。🏅🎉

正如您在文件中看到的,FastAPI 站在巨人的肩膀上,即 Starlette 和 Pydantic。

您也可以贊助


謝謝!🚀