デフォルトのコミュニティ健全性ファイルについて
既定のコミュニティ正常性ファイルは、.github
という名前のパブリック リポジトリ、リポジトリのルート、または docs
や .github
フォルダーに追� できます。
GitHub Enterprise Server は、次のいずれかの� �所にその種類の独自ファイルを持たないアカウントが所有するリポジトリのデフォルトファイルを使用および表示します。
- リポジトリのルート
.github
フォルダーdocs
フォルダー
たとえば、独自の CONTRIBUTING ファイルを持たないリポジトリで Issue またはプルリクエストを作成すると、デフォルトの CONTRIBUTING ファイルへのリンクが表示されます。 リポジトリの独自の .github/ISSUE_TEMPLATE
フォルダーにファイルがある� �合 (Issue テンプレートや config.yml ファイルを含む)、既定の .github/ISSUE_TEMPLATE
フォルダーの内容は使われません。
既定のファイルは、.github
リポジトリにのみ� �納されるため、個別のリポジトリのクローン、パッケージ、ダウンロードには含まれません。
サポートされているファイルの種類
次のコミュニティ正常性ファイルの既定のものを、Organization または個人アカウント に作成できます。
コミュニティ正常性ファイル | 説明 --- | --- CONTRIBUTING.md | CONTRIBUTING ファイルでは、プロジェクトに投稿する方法が示されています。 詳細については、「リポジトリ コントリビューターのためのガイドラインを定める」を参照してく� さい。 Issue と pull request のテンプレートおよび config.yml | Issue と pull request のテンプレートでは、自分のリポジトリに共同作成者が Issue や pull request を開くときに含めてほしい情� �をカスタマイズおよび標準化します。 詳細については、「Issue とプル リクエストのテンプレートについて」を参照してく� さい。 SECURITY.md | SECURITY ファイルでは、プロジェクトでセキュリティ脆弱性を� �告する方法の手� �を示します。 詳細については、「リポジトリにセキュリティ ポリシーを追� する」を参照してく� さい。 SUPPORT.md | SUPPORT ファイルでは、プロジェクトに関するヘルプを得る方法がわかるようにします。 詳細については、「プロジェクトへのサポート リソースの追� 」を参照してく� さい。
デフォルトのライセンスファイルを作成することはできません。 ライセンスファイルは、プロジェクトのクローン時、パッケージ時、またはダウンロード時に含められるよう、個々のリポジトリに追� する必要があります。
デフォルトのファイル用にリポジトリを作成
- ページの右上隅で、[] ドロップダウン メニューを使用して、 [新しいリポジトリ] を選択します。
- [所有者] ドロップダウン メニューを使用し、既定のファイルを作成する Organization または個人アカウント を選択します。
- リポジトリの名前として「 .github」と入力し、必要に応じて説明を入力します。
- リポジトリの状態が [パブリック] に設定されていることを確認します (既定のファイルのリポジトリをプライベートにすることはできません)。 1. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。 1. [Create repository] (リポジトリの作成) をクリックします。
- リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートとその構成ファイルは、
.github/ISSUE_TEMPLATE
という名前のフォルダーに存在する必要があります。 他のすべてのサポートされるファイルは、リポジトリのルート、.github
フォルダー、またはdocs
フォルダーに置くことができます。 詳細については、「新しいファイルの作成」を参照してく� さい。