既定のコミュニティ正常性ファイルの作成

デフォルトのコミュニティ健全性ファイルについて

デフォルトのコミュニティ正常性ファイルとは、健全で協調的なオープンソース プロジェクトを維持するためのガイダンスやテンプレートを提供する事前定義済みファイル一式です。 これらのファイルは、プロジェクトの開発とコミュニティの相互作用のさまざまな側面を自動化および標準化し、透明性、優れたプラクティス、コラボレーションを促進するのに役立ちます。

既定のコミュニティ正常性ファイルを public または internal リポジトリに追加できます。GitHub は、その種類の独自のファイルを持たないアカウントが所有するすべてのリポジトリの既定のファイルを次の順序で使用して表示します。

• .github フォルダー
• リポジトリのルート
• docs フォルダー

現在のリポジトリに対応するファイルが見つからない場合、GitHub は、同じ優先順位に従って .github リポジトリの既定のファイルを使用します。

たとえば、独自の CONTRIBUTING.md ファイルを持たないリポジトリで issue または pull request を作成したユーザーには、.github リポジトリからの既定の CONTRIBUTING.md へのリンクが表示されます。 ただし、リポジトリの独自の .github/ISSUE_TEMPLATE フォルダーに、たとえば issue テンプレートや _config.yml ファイルなどの何らかのファイルがある場合、既定の .github/ISSUE_TEMPLATE フォルダーの内容は使用されません。 これにより、リポジトリの保守担当者は、リポジトリごとに既定のファイルを具体的なテンプレートまたは内容でオーバーライドできるようになります。

.github リポジトリにファイルを格納すると、既定値を 1 か所で変更できます。 さらに、それらは個々のリポジトリのファイル ブラウザーまたは Git 履歴には表示されず、クローン、パッケージ、またはダウンロードには含まれません。

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

プロジェクトのセキュリティの脆弱性が報告された後は、GitHub Security Advisories を使用して、脆弱性に関する情報を開示、修正、公開できます。 GitHub での脆弱性の報告と開示のプロセスに関する詳細については、「AUTOTITLE」を参照してください。 リポジトリ セキュリティ アドバイザリの詳細については、「AUTOTITLE」を参照してください。

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

サポートされるファイルの種類

次のコミュニティ正常性ファイルのデフォルトを、組織または個人用アカウントに作成できます。

コミュニティ正常性ファイル	説明
CONTRIBUTING.md	CONTRIBUTING ファイルは、ユーザーがプロジェクトに貢献する方法を伝えるものです。 詳しくは、「リポジトリコントリビューターのためのガイドラインを定める」をご覧ください。
ディスカッション カテゴリ フォーム	ディスカッション カテゴリ フォームは、コミュニティのメンバーがリポジトリで新しいディスカッションを開くときに使えるテンプレートをカスタマイズできます。 詳しくは、「ディスカッション カテゴリ フォームの作成」をご覧ください。
GOVERNANCE.md	GOVERNANCE ファイルは、プロジェクトの管理方法をユーザーに通知します。 たとえば、プロジェクト ロールと意思決定の方法について説明する可能性があります。
イシューと pull request のテンプレートおよび config.yml	Issue 及び pull request のテンプレートを使用すると、コントリビューターがリポジトリでIssuleやプルリクエストをオープンする際に含めてほしい情報をカスタマイズし、標準化できます。 詳しくは、「Issueとプルリクエストのテンプレートについて」をご覧ください。 Issue テンプレートでラベルを設定する場合、.github リポジトリ内と、そのテンプレートが使われるすべてのリポジトリでそのラベルを作成する必要があります。
SECURITY.md	SECURITY ファイルでは、プロジェクトおよびファイルにハイパーリンクされる説明でセキュリティ脆弱性を報告する方法の手順が示されます。 詳しくは、「リポジトリへのセキュリティ ポリシーの追加」をご覧ください。
SUPPORT.md	SUPPORT ファイルは、プロジェクトを支援する方法をユーザーに通知します。 詳しくは、「プロジェクトへのサポートリソースの追加」をご覧ください。

デフォルトのライセンスファイルを作成することはできません。 ライセンスファイルは、プロジェクトのクローン時、パッケージ時、またはダウンロード時に含められるよう、個々のリポジトリに追加する必要があります。

デフォルトのファイル用にリポジトリを作成

1. ページの右上隅で を選択し、 [新しいリポジトリ] をクリックします。

   

2. [所有者] ドロップダウン メニューを使用し、デフォルトのファイルを作成する組織または個人用アカウントを選択します。

   

3. [リポジトリ名] フィールドに「 .github」と入力します。

4. あるいは、[説明] フィールドに説明を入力します。

5. リポジトリの状態が Public または Internal に設定されていることを確認します。 既定のファイルのリポジトリをプライベートにすることはできません。

6. [ README の追加 ] を [オン] に切り替えます。

7. [Create repository] (リポジトリの作成) をクリックします。

8. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートとその構成ファイルは、.github/ISSUE_TEMPLATE という名前のフォルダーに存在する必要があります。 他のすべてのサポートされるファイルは、リポジトリのルート、.github フォルダー、または docs フォルダーに置くことができます。 詳しくは、「新しいファイルの作成」をご覧ください。