新貢獻者指南#

本指南是為 Apache Arrow 新貢獻者提供的貢獻資源。

無論您目前的技能如何，都可以嘗試為 Arrow 做出您的首次貢獻。

開始為像 Apache Arrow 這樣的專案貢獻可能會讓人感到卻步。採取小步驟將使這項任務更容易。

為什麼要貢獻 Arrow？#

您可能想要貢獻 Arrow 的原因有很多

  • 您覺得這個專案很有趣，並且想嘗試做出貢獻，以了解更多關於這個程式庫的資訊並提升您的技能。

  • 您在正在進行的專案中使用 Arrow，並且想要實作新功能或修復遇到的錯誤。

請在架構概觀章節中閱讀更多關於此專案的資訊。

注意

Apache Arrow 的貢獻者皆遵守 ASF 的行為準則。

快速參考#

以下是設定並貢獻 Arrow 所需的基本步驟。這既是作為一個檢查清單，也是為了提供流程的整體概觀。

如需完整說明，請依照提交您的第一個 PR 的步驟（逐步指南）或 R 和 Python 教學，以取得新增基本功能的範例。

  1. 安裝並設定 Git，並 Fork Arrow 儲存庫

    請參閱關於如何設定 Git 和 Fork Arrow 儲存庫的詳細說明。

  2. 建置 Arrow

    Arrow 程式庫包含廣泛的功能，可能需要安裝第三方套件，具體取決於您啟用的建置選項和組件。C++ 建置指南針對常見問題提供了建議 - 您可以在這裡找到它。如果您遇到任何困難，請隨時透過適當的溝通管道聯繫。

    請參閱關於PyArrow 或 R 套件的建置過程的簡短描述，或直接前往文件中關於如何建置其中一個 Arrow 程式庫的詳細說明。

  3. 執行測試

    我們應該執行測試以檢查一切是否正常運作。例如，您可以從終端機為 Python 執行測試

    $ pytest pyarrow

    或在 R 主控台中為 R 執行測試

    devtools::test()

    另請參閱關於測試 🧪的章節。

  4. 尋找問題（如果需要），建立新分支並處理問題

    尋找問題

    您可能已經有想要修復的錯誤，或者想要實作的新功能。但是，如果您沒有並且需要一個可以處理的問題，那麼您可能需要協助尋找它。請閱讀尋找適合新手入門的問題 🔎章節以獲得一些想法。

    在專案中找到方向

    開始新專案的第一步是最困難的，因此我們編寫了一些指南來協助您。

    您可以先閱讀在 Arrow 程式碼庫上工作 🧐章節。

    溝通

    溝通非常重要。您可能需要一些協助來解決您在過程中遇到的問題（這總是會發生在開發人員身上）。此外，如果您有一個想要解決的 GitHub 問題，那麼最好讓團隊知道您正在處理它，並且可能需要一些協助。

    請參閱可能的溝通管道。

  5. 一旦您實作了計劃的修復或功能，請為其編寫並執行測試

    請參閱關於如何測試的詳細說明。並執行 linter 以確保程式碼在繼續下一步之前已正確設定樣式！

  6. 將分支推送到您的 Fork 並建立 Pull Request

    請參閱關於建立 Pull Request的詳細說明

如果您準備好了，您可以開始建置 Arrow，或選擇依照關於撰寫 R 綁定或 Python 功能的教學之一進行。

不同的貢獻方式#

除了編寫程式碼之外，還有許多其他方式可以為專案做出貢獻！

  • 改善文件是開始貢獻的好方法！如需更多資訊，請造訪指南的協助文件撰寫章節。

  • Apache Arrow 食譜是使用 Apache Arrow 解決各種問題和完成不同任務的食譜集合。它們也是開始貢獻的好方法。如需更多資訊，請造訪位於 Apache Arrow 食譜儲存庫中的How to contribute to Apache Arrow Cookbook。

也歡迎您查看額外資訊與資源章節。

我們鼓勵所有人為 Arrow 做出貢獻！

完整目錄#