Skip to main content

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

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

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

既定のコミュニティ正常性ファイルは、.github という名前のパブリック リポジトリ、リポジトリのルート、または docs.github フォルダーに追加できます。

GitHub は、次のいずれかの場所にその種類の独自ファイルを持たないアカウントが所有するリポジトリのデフォルトファイルを使用および表示します。

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

たとえば、独自の CONTRIBUTING ファイルを持たないリポジトリで Issue またはプルリクエストを作成すると、デフォルトの CONTRIBUTING ファイルへのリンクが表示されます。 リポジトリの独自の .github/ISSUE_TEMPLATE フォルダーにファイルがある場合 (Issue テンプレートや config.yml ファイルを含む)、既定の .github/ISSUE_TEMPLATE フォルダーの内容は使われません。

既定のファイルは、.github リポジトリにのみ格納されるため、個別のリポジトリのクローン、パッケージ、ダウンロードには含まれません。

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

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

コミュニティ正常性ファイル | 説明 --- | --- CODE_OF_CONDUCT.md | CODE_OF_CONDUCT ファイルでは、コミュニティに参加する方法の標準が定義されています。 詳細については、「プロジェクトへの行動規範の追加」を参照してください。 CONTRIBUTING.md | CONTRIBUTING ファイルでは、プロジェクトに投稿する方法が示されています。 詳細については、「リポジトリ コントリビューターのためのガイドラインを定める」を参照してください。 FUNDING.yml | FUNDING ファイルでは、リポジトリにスポンサー ボタンが表示されて、オープンソース プロジェクトの資金調達オプションの表示が増えます。 詳細については、「リポジトリにスポンサー ボタンを表示する」を参照してください。 Issue と pull request のテンプレートおよび config.yml | Issue と pull request のテンプレートでは、自分のリポジトリに共同作成者が Issue や pull request を開くときに含めてほしい情報をカスタマイズおよび標準化します。 詳細については、「Issue とプル リクエストのテンプレートについて」を参照してください。 SECURITY.md | SECURITY ファイルでは、プロジェクトでセキュリティ脆弱性を報告する方法の手順を示します。 詳細については、「リポジトリにセキュリティ ポリシーを追加する」を参照してください。 SUPPORT.md | SUPPORT ファイルでは、プロジェクトに関するヘルプを得る方法がわかるようにします。 詳細については、「プロジェクトへのサポート リソースの追加」を参照してください。

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

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

  1. ページの右上隅で、[] ドロップダウン メニューを使用して、 [新しいリポジトリ] を選択します。 新しいリポジトリを作成するオプションがあるドロップダウン
  2. [所有者] ドロップダウン メニューを使用し、既定のファイルを作成する Organization または個人アカウント を選択します。 [所有者] ドロップダウン メニュー
  3. リポジトリの名前として「 .github」と入力し、必要に応じて説明を入力します。 リポジトリ作成フィールド
  4. リポジトリの状態が [パブリック] に設定されていることを確認します (既定のファイルのリポジトリをプライベートにすることはできません)。 プライベートまたはパブリックの状態を選択するためのラジオ ボタン 1. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。 [このリポジトリを README で初期化する] チェックボックス 1. [Create repository] (リポジトリの作成) をクリックします。 リポジトリを作成するボタン
  5. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートとその構成ファイルは、.github/ISSUE_TEMPLATE という名前のフォルダーに存在する必要があります。 他のすべてのサポートされるファイルは、リポジトリのルート、.github フォルダー、または docs フォルダーに置くことができます。 詳細については、「新しいファイルの作成」を参照してください。