Issues

修复现有问题

改进文档的最佳方法之一是修复现有问题。

1. 浏览问题列表。

2. 选择一个您想处理的问题。

   确保[选择一个问题]，该问题与您的 OpenTelemetry 的经验和理解水平相匹配。避免超出您的能力范围。

3. 阅读问题的评论（如果有）。

4. 通过在问题上发表评论，询问维护者该问题是否仍然相关，并提出您需要澄清的任何问题。

5. 通过添加一个表明您意图的评论，来分享您要处理该问题的意向。

6. 着手修复问题。如果您遇到任何问题，请告知维护者。

7. 准备好后，通过提交您的工作（通过 Pull Request）。

报告问题

如果您注意到一个错误或想改进现有内容，请提交一个问题。

1. 点击任何文档上的创建文档问题链接。这会将您重定向到一个 GitHub 问题页面，该页面已预先填充了一些标题。
2. 描述问题或改进建议。提供尽可能多的细节。
3. 点击创建。

提交后，偶尔检查一下您的问题，或者打开 GitHub 通知。维护者和批准者可能需要几天时间才能响应。审阅者和其他社区成员在处理您的问题之前可能会提出问题。

建议新内容或功能

如果您有新内容或功能的想法，但不确定它应该放在哪里，您仍然可以提交一个问题。您也可以报告错误和安全漏洞。

1. 转到GitHub，在问题选项卡中选择新问题。

2. 选择最适合您请求或疑问的问题类型。

3. 填写模板。

4. 提交问题。

如何提交高质量的问题

提交问题时请牢记以下几点

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