リポジトリへのセキュリティポリシーの追加

セキュリティポリシーをリポジトリに追加することによって、プロジェクト内のセキュリティ脆弱性を報告する方法の手順を示すことができます。

この記事の内容

セキュリティポリシーについて

プロジェクトのセキュリティの脆弱性を報告する手順をユーザーに示すには、SECURITY.md ファイルをリポジトリのルート、docs、または .github フォルダーに追加します。このファイルをリポジトリのこの部分に追加すると、ユーザーがレビューできる説明を含む行が自動的に作成されます。誰かがリポジトリに issue を作成すると、プロジェクトのセキュリティポリシーへのリンクが表示されます。

所属する Organization または個人アカウントにデフォルトのセキュリティポリシーを作成できます。詳しくは、「既定のコミュニティ正常性ファイルの作成」をご覧ください。

Tip

セキュリティポリシーを見つけやすくするには、README ファイルなどのレポジトリ内の別の場所から、SECURITY.md ファイルにリンクさせます。詳しくは、「READMEについて」をご覧ください。

セキュリティの報告の指示を明確に利用できる要することで、ユーザがあなたの好むコミュニケーションチャンネルを使ってリポジトリで見つけたセキュリティ脆弱性を報告することを容易にできます。

実際の SECURITY.md ファイルの例については、「https://github.com/electron/electron/blob/main/SECURITY.md」を参照してください。