建議內容改進

如果您發現 Kubernetes 文件有問題或有新內容的想法，請建立一個 issue。您只需要一個 GitHub 賬戶 和一個網頁瀏覽器。

在大多數情況下，Kubernetes 文件的新工作始於 GitHub 上的一個 issue。然後，Kubernetes 貢獻者會根據需要進行審查、分類和標記 issue。接下來，您或其他 Kubernetes 社群成員將開啟一個 pull request 來更新內容以解決該 issue。

建立 issue

如果您想改進現有內容或發現錯誤，請建立一個 issue。

1. 點選右側邊欄的 “Create an issue” 連結。這會將您重定向到一個已預先填充了一些標題的 GitHub issue 頁面。
2. 描述您發現的問題或改進建議。請提供儘可能多的詳細資訊。
3. 點選 “Submit new issue”。

提交後，請偶爾檢視您的 issue，或開啟 GitHub 通知。審閱者和其他社群成員在採取行動之前可能會提出問題。

建議新內容

如果您有新內容的想法，但不確定它應該放在哪裡，仍然可以提交一個 issue。您可以：

• 選擇您認為內容所屬部分中的一個現有頁面，然後點選 “Create an issue”。
• 直接訪問 GitHub 並提交 issue。

如何建立高質量的 issue

在建立 issue 時，請牢記以下幾點：

• 提供清晰的 issue 描述。具體說明哪些內容缺失、過時、錯誤或需要改進。
• 解釋該 issue 對使用者產生的具體影響。
• 將一個 issue 的範圍限制在一個合理的工作單元內。對於範圍較大的問題，請將其分解為更小的 issue。例如，“修復安全文件”過於寬泛，而“為‘限制網路訪問’主題新增詳細資訊”則足夠具體，可以操作。
• 搜尋現有 issue，檢視是否有與新 issue 相關或相似的內容。
• 如果新 issue 與其他 issue 或 pull request 相關，請透過其完整 URL 或帶有 # 字首的 issue 或 pull request 編號來引用。例如：Introduced by #987654。
• 遵守 行為準則。尊重您的社群貢獻者。例如，“文件太糟糕了”不是一個有用或禮貌的反饋。