您發現了錯誤或您有一個很酷的新功能的想法?貢獻程式碼是回饋開源社群的好方法。在深入研究程式碼之前,我們需要貢獻者遵循一些準則,以便我們有機會掌握最新情況。
確保您有 JIRA 帳戶。
確保您有 GitHub 帳戶。
如果您計劃實現一項新功能,那麼首先在開發清單上討論您的變更是有意義的。這樣您就可以確保您不會將時間浪費在不屬於 Apache Maven 範圍的事情上。
提交您的問題的票證(假設尚不存在)。
清楚地描述問題,包括當它是錯誤時重現的步驟。
確保填寫您知道有問題的最早版本。
在 GitHub 上分叉儲存庫。
我們透過 GitHub 接受 Pull 請求。開發者郵件清單是貢獻者溝通的主要管道。
有一些指南可以讓我們更輕鬆地申請 PR:
從您想要作為工作基礎的位置建立主題分支(通常是主分支)。將您的變更推送到儲存庫分支中的主題分支。
提交邏輯單元。
尊重原始程式碼風格:透過使用相同的程式碼風格,補丁應該只突出實際的差異,而不會受到任何格式問題的干擾:
僅使用空格進行縮排。
建立最小差異 - 停用儲存操作,例如重新格式化原始碼或組織匯入。如果您認為應該重新格式化原始程式碼,請為此變更建立單獨的 PR。
在提交之前使用git diff --check
檢查不必要的空格。
確保您的提交訊息採用正確的格式。您的提交訊息應包含 JIRA 問題的金鑰。
[MSHARED-XXX] - Subject of the JIRA Ticket Optional supplemental description.
確保您已為變更新增了必要的測試 (JUnit/IT)。
使用mvn -Prun-its verify
執行所有測試,以確保沒有其他內容意外破壞。
向 Apache 組織中的儲存庫提交拉取請求。
更新您的 JIRA 票證並在票證中包含指向拉取請求的連結。
如果您計劃定期貢獻,請考慮提交貢獻者授權協議。
對於註釋和文件的微不足道的更改,並不總是需要在 JIRA 中建立新的票證。 在這種情況下,適合以「(doc)」而非票號開始提交的第一行。
貢獻補丁
Apache Maven 共享元件專案頁面
貢獻者授權協議
一般 GitHub 文檔
GitHub 拉取請求文檔
Apache Maven Twitter 帳戶
freenode.org 上的 #Maven IRC 頻道