建議內容改進

如果您發現 Kubernetes 文件有問題,或對新內容有想法,請開啟 Issue。您只需要一個 GitHub 帳戶和網頁瀏覽器。

在大多數情況下,Kubernetes 文件的新工作始於 GitHub 中的 Issue。然後,Kubernetes 貢獻者會根據需要審閱、分類和標記 Issue。接下來,您或 Kubernetes 社群的其他成員會開啟提取請求,並進行變更以解決 Issue。

開啟 Issue

如果您想建議改進現有內容或發現錯誤,請開啟 Issue。

  1. 按一下右側邊欄上的建立 Issue 連結。這會將您重新導向至預先填入一些標頭的 GitHub Issue 頁面。
  2. 描述 Issue 或改進建議。請盡可能提供詳細資訊。
  3. 按一下提交新 Issue

提交後,請偶爾查看您的 Issue 或開啟 GitHub 通知。審閱者和其他社群成員可能會在他們對您的 Issue 採取行動之前提出問題。

建議新內容

如果您對新內容有想法,但不確定應該放在哪裡,您仍然可以提交 Issue。您可以

  • 在您認為內容所屬的區段中選擇現有頁面,然後按一下建立 Issue
  • 前往 GitHub 並直接提交 Issue。

如何提交出色的 Issue

提交 Issue 時,請記住以下幾點

  • 提供清楚的 Issue 描述。說明具體缺少、過時、錯誤或需要改進的內容。
  • 說明 Issue 對使用者的具體影響。
  • 將特定問題的範圍限定在合理的工作單元內。對於範圍過大的問題,請將其分解為較小的問題。例如,「修正安全性文件」範圍太廣,但「在『限制網路存取』主題中新增詳細資訊」就夠具體且可執行。
  • 搜尋現有的問題,看看是否有任何相關或類似於新問題的項目。
  • 如果新問題與另一個問題或提取請求相關,請參照它,可以使用完整網址,或使用以 # 字元為前綴的問題或提取請求編號。例如,由 #987654 引入
  • 請遵守行為準則。尊重您的貢獻者夥伴。例如,「這些文件寫得真爛」並非有幫助或禮貌的回饋。
上次修改時間為太平洋標準時間 2023 年 7 月 12 日凌晨 1:25:修訂文件首頁 (9520b96a61)