イシュー

既存のイシューの修正

ドキュメントを改善するための最も良い方法の 1 つは、既存のイシューを修正することです。

1. issues のリストを参照してください。

2. 作業したいイシューを選択してください。

   重要！

   自分の OpenTelemetry に関する経験と理解のレベルに合ったイシューを選択してください。 自分の能力を超えたイシューに取り組むことは避けてください。 CI/infra ラベルが付いたイシューはメンテナー専用です。

3. イシューにコメントがある場合、内容を読んでください。

4. このイシューがまだ関係あるかをメンテナーに尋ね、明らかにしたい質問がある場合はイシューにコメントを投稿して質問してください。

5. この旨のコメントを追加して、問題に取り組む意向を共有してください。

6. イシューの修正に取り組みましょう。問題が発生した場合は、メンテナーに知らせてください。

7. 準備ができれば、プルリクエストを通じてあなたの作業を提出してください（PR）。

CI とインフラストラクチャのイシュー

CI/infra ラベルが付いたイシューはメンテナー専用です。 リポジトリ自体のワークフロー、必須チェック、ツール、設定に関するものです。 コンテンツやローカリゼーションの作業とは異なり、以下の特徴があります。

• この領域の変更は、メンテナー以外が有意義にテストすることができません。 たとえば、障害モードは上流の CI やマージ時の動作で表面化します。
• 作業はメンテナーのロードマップやイシューのテキストからは見えないコンテキストに依存することが多いです。
• 一部のコンテキストは意図的に非公開です。 サイトのセキュリティ体制に影響する作業（堅牢化や修正）は、マージされるまで公には議論されません。

このようなイシューに triage:accepted が付いている場合、問題が確認されたことを意味するのであり、作業を誰でも自由に引き受けられるという意味ではありません。

イシューの報告

エラーに気が付いたり既存の内容に改善を提案したい場合は、イシューを開いてください。

1. 任意のドキュメントのドキュメントのissueを作成のリンクをクリックしてください。これにより、ヘッダーがあらかじめ入力された GitHub のイシューページにリダイレクトされます。
2. 問題点または改善の提案を説明してください。できるだけ多くの詳細を提供してください。
3. 作成 をクリックしてください。

提出した後に、あなたのイシューを時々確認するか、GitHub の通知をオンにしてください。 メンテナーと承認者が反応するまで、数日かかる場合があります。 レビュアーやほかのコミュニティメンバーがイシューに対処する前に質問する場合があります。

新しいコンテンツや機能の提案

新しいコンテンツや機能のアイデアを持っているが、どこに配置すべきかわからない場合、イシューに提出できます。 バグとセキュリティの脆弱性も同様に報告できます。

1. GitHub に行って Issues タブから New issue を選択してください。
2. 要望または疑問に最も適したイシューの種類を選択してください。
3. テンプレートに入力してください。
4. イシューを提出してください。

優れたイシューの作成方法

イシューを作成する際には、以下の点に注意してください。

• 明確な説明を提供してください。何が欠けていて、古くなっていて、間違っていて改善を必要としているのか説明してください。
• ユーザーへの具体的な影響を説明してください。
• イシューの範囲は合理的な範囲に制限してください。問題の範囲が大きい場合は、小さなイシューに分割してください。たとえば、「セキュリティドキュメントを修正する」は広すぎますが、「『ネットワークアクセスの制限』のトピックに詳細を追加する」は具体的で実行しやすいです。
• 新しいイシューに関連していて似たようなイシューが存在していないか探してください。
• 新しいイシューがほかのイシューやプルリクエストに関連している場合は、該当する URL 全文を記載するか、# をつけてイシュー番号やプルリクエスト番号を記述してください。たとえば、Introduced by #987654 です。
• Code of Conduct に従ってください。 ほかのコントリビューターを尊重しましょう。 「このドキュメントはひどい」のような発言は、有益でも礼儀正しくもありません。