建议内容改进

如果您发现 Kubernetes 文档存在问题或对新内容有想法，请提交 issue。您只需要一个 GitHub 账户 和一个网络浏览器。

在大多数情况下，Kubernetes 文档的新工作都从 GitHub 中的 issue 开始。Kubernetes 贡献者会根据需要审查、分类和标记 issue。接下来，您或 Kubernetes 社区的其他成员会打开一个 pull request，其中包含更改以解决该 issue。

提交 issue

如果您想提出对现有内容的改进建议或发现错误，请提交 issue。

1. 单击右侧边栏上的 创建 issue 链接。这将重定向您到一个预先填充了一些标题的 GitHub issue 页面。
2. 描述 issue 或改进建议。提供尽可能多的详细信息。
3. 单击 提交新 issue。

提交后，偶尔检查您的 issue 或打开 GitHub 通知。审查者和其他社区成员可能会在采取行动之前提出问题。

建议新内容

如果您对新内容有想法，但不确定应该放在哪里，您仍然可以提交 issue。您可以

• 选择您认为内容应该属于的章节中的现有页面，然后单击 创建 issue。
• 转到 GitHub 并直接提交 issue。

如何提交优秀的 issue

提交 issue 时请记住以下几点

• 提供清晰的 issue 描述。描述具体缺少什么、过时、错误或需要改进的地方。
• 解释 issue 对用户造成的具体影响。
• 将给定 issue 的范围限制在一个合理的单位工作。对于范围较大的问题，将其分解为较小的 issue。例如，“修复安全文档”过于宽泛，但“在‘限制网络访问’主题中添加详细信息”足够具体，可以采取行动。
• 搜索现有的 issue，看看是否有任何相关或类似的新 issue。
• 如果新的 issue 与另一个 issue 或 pull request 相关，请通过其完整 URL 或带有 # 字符前缀的 issue 或 pull request 号引用它。例如，由 #987654 引入。
• 遵守 行为准则。尊重您的贡献者。例如，“文档很糟糕”不是有帮助或礼貌的反馈。