建议内容改进

如果您发现 Kubernetes 文档存在问题，或者有关于新内容的想法，请开启一个议题。您只需要一个 GitHub 账户和一个网页浏览器即可。

在大多数情况下，针对 Kubernetes 文档的新工作都是从 GitHub 上的一个议题开始的。Kubernetes 贡献者随后会根据需要对议题进行审核、分类和标记。接下来，您或 Kubernetes 社区的另一位成员会通过发起拉取请求（Pull Request）来提交变更以解决该议题。

开启一个议题

如果您想建议对现有内容进行改进或发现了错误，请开启一个议题。

1. 点击右侧边栏中的 Create an issue（创建议题）链接。这会将您重定向到一个预填充了部分标题的 GitHub 议题页面。
2. 描述该问题或改进建议。请提供尽可能详细的信息。
3. 点击 Submit new issue（提交新议题）。

提交后，请偶尔查看您的议题或开启 GitHub 通知。在采取行动之前，审核者和其他社区成员可能会向您提问。

建议新内容

如果您有关于新内容的想法，但不确定它应该放在哪里，您仍然可以开启一个议题。您可以：

• 在您认为内容所属的章节中选择一个现有页面，然后点击 Create an issue（创建议题）。
• 前往 GitHub 直接开启议题。

如何撰写优秀的议题

开启议题时请记住以下几点

• 提供清晰的议题描述。描述具体缺失、过时、错误的内容，或需要改进的地方。
• 解释该问题对用户造成的具体影响。
• 将议题的范围限制在合理的工作单元内。对于范围较大的问题，请将其拆分为较小的议题。例如，“修复安全文档”太笼统，而“向‘限制网络访问’主题添加详细信息”则足够具体，具有可操作性。
• 搜索现有的议题，看看是否有与新议题相关或相似的内容。
• 如果新议题与另一个议题或拉取请求相关，请通过其完整 URL 或以 # 字符为前缀的议题/拉取请求编号来引用它。例如，由 #987654 引入。
• 遵守 行为准则。尊重您的贡献者同僚。例如，“文档太烂了”这种反馈既没用又不礼貌。