Skip to main content

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

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

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

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

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

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

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

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

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

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [ セキュリティ] をクリックします。 [セキュリティ] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [セキュリティ] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [セキュリティ] タブが濃いオレンジ色の枠線で強調表示されています。

  3. 左側のサイドバーの [レポート] で、 [ ポリシー] をクリックします。

  4. [Start setup] (セットアップの開始) をクリックします。

  5. 新しい SECURITY.md ファイルで、サポートされているプロジェクトのバージョンに関する情報と、脆弱性を報告する方法を追加します。

  6. [変更のコミット...] をクリックします。

  7. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」を参照してください。

  8. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」を参照してください。

    GitHub pull request のスクリーンショット。メイン ブランチに直接コミットする、または新しいブランチを作成するためのラジオ ボタンが表示されています。 新しいブランチが選ばれています。

  9. [変更のコミット] または [変更の提案] をクリックします。

参考資料