問題分類

本指南適用於維護人員。這些特別人士對 Jekyll 的一個或多個儲存庫具有寫入權限,並協助合併他人的貢獻。您可能會覺得這裡寫的內容很有趣,但它絕對不適合所有人。

在評估問題之前,重要的是要找出它是功能請求還是錯誤。對於 Jekyll 專案,下列定義用於識別功能或錯誤

功能 - 功能定義為在 Jekyll 目前功能之外新增功能的請求。錯誤 - 錯誤定義為使用者在使用目前 Jekyll 功能時遇到的錯誤問題。

功能嗎?

如果問題描述功能請求,請詢問

  1. 這是設定嗎?設定是執行「正確的事情」的拐杖。設定通常指向不良的預設值或邊緣案例,而這些案例可以用外掛程式輕鬆解決。將:christmas_tree:設定保持在最小值,以免降低產品的可用性。我們喜歡「決定而非選項」的哲學。
  2. 至少 80% 的使用者會覺得它有用嗎?如果連四分之一的使用者都不會使用它,那麼這個要求很可能不符合我們產品的核心目標。
  3. 是否有其他方法可以達成這個要求的最終目標?大多數功能要求都是因為對現有功能的說明文件不良或理解不足。看看您是否可以釐清這個要求的最終目標。使用者想要做什麼?他們是否可以透過我們已經支援的其他功能來達成這個目標?
  4. 即使 80% 的使用者會使用它,它是否符合我們專案的核心目標?我們編寫的工具是為了製作靜態網站,而不是用於更廣泛發布的瑞士刀。

歡迎徵詢他人的意見,並詢問問題的作者,但根據上述問題的答案,這可能超出我們專案的範圍。

如果這個要求在範圍內,請與其他維護人員一起在產品路線圖中優先處理它。套用適當的標籤,並確保適當的人員參與定義功能的範圍和實作。如果您想成為史上最佳,請自行提交一個 PR 來新增這個功能。

錯誤?

可重現性

如果錯誤有明確的可重現步驟,請花點時間嘗試這些步驟。如果這有幫助,請在我們的測試套件中撰寫一個測試,以複製問題的場景。你能可靠地複製這個問題嗎?

如果你無法複製這個問題,請發佈你的複製步驟(這些步驟不起作用),並要求問題作者澄清。

支援的平台

作者是否使用支援的平台?我們支援 macOS、Ubuntu、Debian、CentOS、Fedora 和 Arch Linux 的最新版本。

如果作者無法在支援的平台上複製這個問題,你可以立即關閉這個問題。對於與 Windows 相關的問題,請留言讓使用者知道 Windows 並未獲得官方支援,但他們絕對可以繼續使用這個問題與 @jekyll/windows 中的人員溝通,以進一步調查。此外,你可以將他們導向 Jekyll Talk (https://talk.jekyllrb.com) 作為從社群獲得支援的方法。

如果使用者遇到我們無法複製的 GitHub Pages 或其他託管平台問題,請將他們導向該平台的支援管道,並關閉這個問題。

他們想要什麼與他們得到什麼

一個問題如果沒有明確說明使用者得到什麼以及他們期望得到什麼,就不是我們可以準確回應的問題。如果使用者沒有提供這些資訊,請要求澄清,並套用 pending-feedback 標籤。這些資訊有助於我們建立測試案例,以便我們在未來不再破壞行為。一旦問題作者發佈回覆,pending-feedback 標籤將自動移除。

他們想要得到的是我們想要發生的事嗎?有時候,一個錯誤報告實際上偽裝成一個功能要求。請參閱上述指南,以處理功能要求。

陳舊和自動關閉

@jekyllbot 如果至少一個月沒有活動,將自動標記問題為 stale@jekyllbot 會留下評論,詢問有關當前版本中重現性的資訊。如果在另一個月後沒有人回應,問題將自動關閉。可以透過設定 pinned 標籤 來抑制此行為。