貢獻者 Pull Request 指南


感謝你願意為 Exercism 貢獻一份心力! 建立 Pull Request 之前,請先閱讀如何做出優質的 Pull Request指南。這份指南著重於 Pull Request 的非技術層面,希望能讓你擁有良好的體驗,同時也減輕我們維護團隊的負擔。

本文件另外收錄了一些針對不同類型 Pull Request 的 Exercism 專屬準則。

練習的 Pull Request

由於這類練習有許多規則,要為概念練習或實作練習建立 Pull Request 可能會讓人卻步。 因此,維護者可能需要花上兩到三個小時審查,還會產生數十則留言。 為了協助你,會有位主要審查者專門針對你的 Pull Request 留言。

不要因為審查留言的數量而灰心;一份練習在讓你與主要審查者都滿意之前,經過幾次改寫是完全正常的。

建議

以下是一些建議,能讓流程更加順暢。

閱讀說明文件

在為某個練習建立 Pull Request 之前,請務必閱讀概念練習說明文件或實作練習說明文件。 事先閱讀說明文件非常有幫助,因為這樣審查時的留言會少很多,你的 Pull Request 也能更快被合併。

觀摩現有的練習(如果有的話)

如果該學習軌道已有現成的練習,不妨花點時間研究一下,了解它們的樣貌與結構。

實作練習的 Pull Request

思考這項變更是否真的該放在 problems-specifications

實作練習的部分內容(例如它的簡介)來自 problems-specifications 儲存庫 中所定義的(共用)中繼資料。 如果你打算更新這類內容,請想想這項變更是否也能讓其他學習軌道受益。 如果是的話,請改為向 problems-specifications 儲存庫 中該練習的中繼資料提出 Pull Request。

一般建議

請勿進行未經請求的審查

所有 Pull Request 審查都由該學習軌道的一位(或多位)維護者進行,因為他們負責核准儲存庫的所有變更。 由維護者負責審查,也有助於避免 Pull Request 作者收到互相衝突的意見回饋。

當然,我們也歡迎你留言協助審查(尤其是在較大的 Pull Request 中),或者在你發現任何看似錯誤的地方時提出疑問。