Uploaded avatar of iHiD

全新的貢獻指南

@iHiD
接近3年前

如果你是因為 Issue/PR 被自動關閉而被引導到這裡,請不要驚慌,也別覺得自己被拒絕了。你付出的心力,往往最終會合併進 Exercism,或者你的問題會得到解決。我們歡迎也鼓勵大家貢獻,只是喜歡先在論壇上討論,再動手寫 GitHub 上的程式碼。開一篇論壇討論串,就能讓事情往前推進。


過去一年來,我們一直在嘗試限制非維護者的貢獻,好騰出核心貢獻者的時間,讓他們能為學習軌道做出更重大的改善。 這個做法成效相當不錯。 相較於 2022 年,2023 年我們看到新增的練習數量達到兩倍,新建立的教學大綱數量更達到三倍。 做法的調整,讓核心貢獻者能接受規模更大的貢獻,也減少了挫折與分心。

不過,我也明白,這對一些有心幫忙、卻覺得被我們的貢獻流程擋住的新貢獻者來說,帶來了挫折感。 所以今天,我想提出一些新的(或說得更清楚的)指引,說明接下來幾個月我們要如何推展貢獻這件事。

最根本、也最需要理解的一條規則是:我們在論壇上討論想法、bug 與問題,並在 GitHub 上(透過 PR 審查)討論隨之而來的程式碼變更。 第二條規則是:除了有自主權的維護者之外,我們都先討論、再動手。 我們的論壇讓不同學習軌道的貢獻者與維護者,能就各式各樣的程式語言和想法交流知識與經驗,而不必訂閱 GitHub 上 300 個不同的儲存庫,把通知塞爆。

更新後的指引

尋求支援

  • 如果在解練習之前卡住了(例如安裝 CLI、執行測試,或是卡在練習的邏輯/需求上),我們的支援管道是論壇上的「Exercism Support」類別,以及 Discord 伺服器上的 #get-help 頻道。
  • 我們不用 GitHub 或電子郵件處理支援請求。
  • 如果你已經解完某個練習,但對它還有疑問,應該直接在 Exercism 上申請導師引導。

回報 bug 與問題

  • 所有的 bug/問題都應該在論壇上提出,那裡有各種背景的人能幫忙理解並解決問題。
    • 如果問題與某個程式語言有關,請使用對應的 Programming/xxx 類別。
    • 如果是網站上的 bug,請使用「Bugs & Feature Requests」類別。
  • GitHub issue 通常會自動關閉,並把張貼者導向論壇(附上可一鍵複製/貼上其 issue 的連結,就和目前的做法一樣)。
  • 學習軌道的維護者可以選擇關閉自動關閉 issue 的功能,但官方管道仍然是論壇。

建立 Pull Request

  • 在動手之前,Pull Request 應該先在論壇上討論過。
  • 非組織成員提出的 Pull Request 仍會自動關閉,但一旦在論壇上討論過相關工作,通常會重新開啟。 如果某個 PR 背後的想法已經獲得批准,只要在相關的論壇討論串中附上該 PR 的連結,我們就會重新開啟它。
  • 學習軌道的維護者可以選擇關閉自動關閉 PR 的功能,但我們仍建議所有 PR 都先透過論壇討論。

總結

我們的首要任務,依然是保護核心貢獻者的時間與心力,沒有他們,Exercism 就無法運作。 但我們也希望確保 Exercism 仍是一個讓新朋友能在沒有過度門檻的情況下參與的地方,也是我們能鼓勵並支持他們成為核心貢獻者的地方!

我很期待看到這些改變在接下來幾個月如何影響我們收到的貢獻。 我們會在 2024 年年中再次檢視。

Translation missing: zh-TW.number.nth.ordinalized Nov 2023 · 覺得有幫助嗎?