提出内容改进建议

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

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

打开一个 issue

如果您想对现有内容提出改进建议或发现错误，请打开一个 issue。

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

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

提出新内容建议

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

• 在您认为内容所属的部分中选择一个现有页面，然后单击创建 issue。
• 转到 GitHub 并直接提交 issue。

如何提交出色的 issue

提交 issue 时请牢记以下几点

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