發送 Pull Request

警告

本文档是针对旧版 SpongeAPI 编写的，目前已不再维护。虽然相应的代码依然能在对应的 API 下工作，但相关政策、方针及链接可能有所变化。请在必要时参阅最新的文档获得相关信息。

基礎

首先，您需要設置您的機器以能夠開發 Sponge 與使用 Sponge 進行開發。

• 閱讀 準備開發 並設置您的機器

• 熟悉 git 與 GitHub： 如何 Git(hub)

• 閱讀我們的 程式碼風格頁面 與 貢獻指南

• 熟悉我們的 API 與實作的 Git 工作流程

當您完成並認為您已經做好開發 Sponge 的準備時，決定您想參與哪個部分。

撰寫 PR

修復 Bug

用幾句話解釋：

• 你遇到哪個 bug，尤其是

  • 它如何表現

  • 你認為它應該如何表現

• 你修復了什麼

• 你如何修復它

重大 API 擴充

你已經開發了相當大的 API 擴充並想做為一個 PR 進行提交。很棒！建設性的 PR 會讓這個專案不斷變好，這帶領我們寫出輝煌的 PR 描述。

過去有一些超出標準的例子，如：

• Inventory API PR

• Data API PR

當然，這些是極端的例子，以下則是一些已被接受的 PR，可以作為一個 PR 描述應該包含什麼內容的好標準：

• Event Filtering PR

• Bans improvement API PR

可被採用的幾件事：

• 在 PR 的開頭清楚給出任何實作的 PR 的連結，這可以用 GitHub Markdown 做到。

*SpongeAPI*|[SpongeCommon](html link)|[SpongeForge](html link)|[SpongeVanilla](html link)

• 對該 API PR 的目的清楚描述，根據其功能撰寫簡短的摘要，如同短文般，最多4個句子。

• 清楚的程式碼範例，舉例插件如何使用這個新特性（若有舊特性存在，說明為什麼需要改變它們）。