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

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

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

既定のコミュニティ正常性ファイルを .github という名前のパブリック リポジトリに追加でき、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 履歴には表示されず、クローン、パッケージ、またはダウンロードには含まれません。

リポジトリ メンテナとして、人がプロジェクトを利用し、プロジェクトに貢献できるよう、推奨されるコミュニティ標準をプロジェクトが満たしているかを確認するため、コミュニティ標準チェックリストを使うことができます。 詳しくは、「パブリックリポジトリのコミュニティプロフィールについて」をご覧ください。

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

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

コミュニティ正常性ファイル	説明
CODE_OF_CONDUCT.md	CODE_OF_CONDUCT ファイルは、コミュニティでの関与の仕方の基準を定義したものです。 詳しくは、「プロジェクトへの行動規範の追加」をご覧ください。
CONTRIBUTING.md	CONTRIBUTING ファイルは、ユーザーがプロジェクトに貢献する方法を伝えるものです。 詳しくは、「リポジトリコントリビューターのためのガイドラインを定める」をご覧ください。
ディスカッション カテゴリ フォーム	ディスカッション カテゴリ フォームは、コミュニティ メンバーがリポジトリで新しいディスカッションを開くときに使用できるテンプレートをカスタマイズします。 詳しくは、「ディスカッション カテゴリ フォームの作成」をご覧ください。
FUNDING.yml	FUNDING ファイルは、リポジトリにスポンサー ボタンを表示し、オープン ソース プロジェクトの資金調達オプションの可視性を高めます。 詳しくは、「リポジトリにスポンサーボタンを表示する」をご覧ください。
GOVERNANCE.md	GOVERNANCE ファイルは、プロジェクトの管理方法をユーザーに通知します。 たとえば、プロジェクト ロールと意思決定の方法について説明する可能性があります。
イシューと pull request のテンプレートおよび config.yml	課題や pull request のテンプレートは、共同作成者がリポジトリで課題や pull request を開く場合に含める情報をカスタマイズし、標準化します。 詳しくは、「Issueとプルリクエストのテンプレートについて」をご覧ください。
SECURITY.md	SECURITY ファイルでは、プロジェクトおよびファイルにハイパーリンクされている説明でのセキュリティ脆弱性を報告する方法の手順が示されます。 詳しくは、「リポジトリへのセキュリティ ポリシーの追加」をご覧ください。
SUPPORT.md	SUPPORT ファイルは、プロジェクトを支援する方法をユーザーに知らせます。 詳しくは、「プロジェクトへのサポートリソースの追加」をご覧ください。

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

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

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

   

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

   

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

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

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

6. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。

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

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