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

CONTRIBUTING や CODE_OF_CONDUCT など、デフォルトのコミュニティ健全性ファイルを作成できます。 デフォルトのファイルは、そのような種類の独自ファイルを持たないアカウントが所有するすべてのリポジトリに使用されます。

この記事で

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

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

既定のコミュニティ正常性ファイルは、 .github というリポジトリに追加できます。

マネージド ユーザーを含む組織の場合、.github リポジトリは内部である必要があります。 他のすべてのアカウントの場合、 .github リポジトリは public.

GitHub は、コピー先リポジトリの可視性に関係なく、その種類の独自のファイルを持たない、アカウントが所有するすべてのリポジトリの既定のファイルを使用して表示します。 複数の場所に格納できるサポートされているファイルの場合、 GitHub は次の優先順位を使用します。

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

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

たとえば、独自の CONTRIBUTING.md ファイルを持たないリポジトリで issue または pull request を作成したユーザーには、CONTRIBUTING.md リポジトリからの既定の .github へのリンクが表示されます。 ただし、リポジトリで有効な問題テンプレートまたは発行テンプレートの構成が独自の .github/ISSUE_TEMPLATE フォルダーに定義されている場合、既定の .github/ISSUE_TEMPLATE フォルダーの内容は使用されません。 これにより、リポジトリの保守担当者は、リポジトリごとに特定のテンプレートまたはコンテンツを使用して既定のファイルをオーバーライドできます。

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

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

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

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

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

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

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

コミュニティ正常性ファイル説明
CODE_OF_CONDUCT.mdCODE_OF_CONDUCT ファイルは、コミュニティに参加する方法の標準を定義します。 詳細については、 AUTOTITLE を参照してください。
CONTRIBUTING.mdCONTRIBUTING ファイルは、ユーザーがプロジェクトに貢献する方法を伝えるものです。 詳しくは、「リポジトリコントリビューターのためのガイドラインを定める」をご覧ください。
ディスカッション カテゴリ フォームディスカッション カテゴリ フォームは、コミュニティのメンバーがリポジトリで新しいディスカッションを開くときに使えるテンプレートをカスタマイズできます。 詳しくは、「ディスカッション カテゴリ フォームの作成」をご覧ください。
FUNDING.ymlFUNDING ファイルには、リポジトリにスポンサー ボタンが表示され、オープンソース プロジェクトの資金調達オプションの可視性が向上します。 詳しくは、「リポジトリにスポンサーボタンを表示する」をご覧ください。
イシューと pull request のテンプレートおよび config.ymlIssue 及び pull request のテンプレートを使用すると、コントリビューターがリポジトリでIssuleやプルリクエストをオープンする際に含めてほしい情報をカスタマイズし、標準化できます。 詳しくは、「Issueとプルリクエストのテンプレートについて」をご覧ください。

Issue テンプレートでラベルを設定する場合、.github リポジトリ内と、そのテンプレートが使われるすべてのリポジトリでそのラベルを作成する必要があります。
SECURITY.mdSECURITY ファイルでは、プロジェクトおよびファイルにハイパーリンクされる説明でセキュリティ脆弱性を報告する方法の手順が示されます。 詳しくは、「リポジトリへのセキュリティ ポリシーの追加」をご覧ください。
SUPPORT.mdSUPPORT ファイルは、プロジェクトを支援する方法をユーザーに通知します。 詳しくは、「プロジェクトへのサポートリソースの追加」をご覧ください。

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

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

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

    新しいアイテムを作成するオプションを示す GitHub ドロップダウン メニューのスクリーンショット。 [新しいリポジトリ] というメニュー項目が濃いオレンジ色の枠線で囲まれています。

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

新しい GitHub リポジトリの所有者メニューのスクリーンショット。 メニューには、octocat と github の 2 つのオプションが表示されます。

  1. [リポジトリ名] フィールドに「 .github」と入力します。
  2. あるいは、[説明] フィールドに説明を入力します。

マネージド ユーザーを含む組織のリポジトリを作成する場合は、リポジトリの状態を [内部] に設定します。 その他のアカウントの場合は、状態を Public. 既定のファイルのリポジトリをプライベートにすることはできません。

  1. [ README の追加 ] を [オン] に切り替えます。
  2. [Create repository] (リポジトリの作成) をクリックします。
  3. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 ディスカッション カテゴリ フォームは、 .github/DISCUSSION_TEMPLATEという名前のフォルダーに存在する必要があります。 Issue テンプレートとその構成ファイルは、.github/ISSUE_TEMPLATE という名前のフォルダーに存在する必要があります。

FUNDING.yml ファイルは、.github フォルダーに存在する必要があります。 他のすべてのサポートされているファイルは、リポジトリのルート、 .github フォルダー、または docs フォルダーにあります。 詳しくは、「新しいファイルの作成」をご覧ください。