API 與實作的 Git 工作流程

開發 API

添加變更的基本流程在 如何 Git(hub) 章節闡述。除此之外，我們建議你使用具有意義的名稱來建立新分支。有鑑於使用新分支模型，你必須知道你的 PR 基於哪個分支與其應被合併至哪個分支。關於新分支與版本模型請參閱： 專案分支布局

另外，我們要求你確保模組可透過 gradle compileJava 編譯。這將執行原始碼的簡易建置。當順利完成，你可以將你的變更透過 PR 送至 SpongeAPI 儲存庫。

開發實作

對於實作的流程幾乎與對於 API 一致。根據 如何 Git(hub) 所描述的添加你的變更。請注意，你需要給你的分支一個具有意義的名稱。有鑑於使用新分支模型，你必須知道你的 PR 基於哪個分支與其應被合併至哪個分支。關於新分支與版本模型請參閱： 專案分支布局

執行 gradle compileJava 來確認能順利編譯且沒有錯誤。

當你修改實作時，有可能包含修改 API。這是可以的，只要記得在提交與推送之前，確保 SpongeAPI 的版本指標與你的分支是一致的。為了做到這點，你可能需要在提交你的實作修改前，將子模組添加至提交（透過 git add SpongeAPI 與/或 git add Mixin ）。

當你的提交被推送至你的 fork 或儲存庫，你就可以開啟一個 Pull Request。