貢獻指南

總是需要開發人員來協助我們改進 SpongeAPI。沒有一個專案是完美的,總是會有可以改進的地方。如果你是有興趣提供協助的開發人員,請不要猶豫。只要確保你遵守我們的準則。

備註

對專案的貢獻中表現出決心和一致性的開發人員可能會被團隊領導主動邀請加入 Sponge Staff。沒有正式的申請程序。請不要要求當工作人員,我們會主動問你。

大致的步驟

  1. 根據 準備開發 的描述設定工作空間。
  2. 確保你熟悉 Git 和 GitHub。如果您的知識需要刷新,請參閱 如何 Git(hub)
  3. SpongeAPISpongeCommonSpongeForgeSpongeVanillaSpongeDocs 儲存庫中尋找已存在的 Issue。其他人有可能已經著手於相同的事情。您還可以檢查標有 「help wanted」 的 Issue,我們需要您為已存在的 Issue 提供協助。

備註

請不要提交低於 20 行的小改動的 Pull Request。而是 加入 #sponge 的 IRC(irc.esper.net) 或是 加入 #spongedev 的 IRC(irc.esper.net),我們會和其他較小的更動一起進行更改。

  1. 如果你想提交一個更大的改變,在實際提交前請先提交 Issue,這樣我們就能確認這個問題並知道是你正在修正它。你應當儘早創建一個以 [WIP] 開頭的 WIP(Work In Progress,工作進行中)Pull Request,這樣我們就能開始審查它們。
  2. Fork 這個專案,克隆(clone)它並將你的改動放到一個額外的分支。
  3. 測試你的改動(至少能編譯),提交並推送到你自己的 fork 上。
  4. 提交一個 Pull Request,附帶一段介紹,解釋你更動了什麼與為什麼應該要那樣更動。
  5. 如果你做了額外的更動,請推送新提到到你的分支。不要把所有的更動 Squash 在一起,那會使你在查看與 Pull Request 中更早的版本的比較時異常困難。
  6. 確保你的 PR 已經 rebase 到你想合併到的分支的最新更動。如果你需要幫助來 rebase 它,請詢問!

小訣竅

如果您不確定該基於哪個分支工作,請在提交您的 PR 之前閱讀我們的 版本控制系統與儲存庫分支佈局