デフォルトのコミュニティ健全性ファイルについて
Organizationが所有する .github
というパブリックリポジトリのルートにデフォルトのコミュニティ健全性ファイルを追加できます。
GitHub Enterpriseは、次のいずれかの場所にそのタイプの独自のファイルがないアカウントのパブリックリポジトリについては、デフォルトファイルを使用および表示します。
- リポジトリのルート
.github
フォルダdocs
フォルダ
たとえば、独自の CONTRIBUTING ファイルを持たないパブリックリポジトリに Issue やプルリクエストを作成する人は誰でも、デフォルトの CONTRIBUTING ファイルへのリンクが見られます。 リポジトリの独自の .github/ISSUE_TEMPLATE
フォルダ内に
ファイルがある場合、デフォルトの.github/ISSUE_TEMPLATE
フォルダにあるコンテンツは使用されません。
デフォルトのファイルは .github
リポジトリにのみ格納されるものであって、クローン、パッケージ、リポジトリ個別のダウンロードには含まれません。
サポートされているファイルの種類
Organization に対して、次のコミュニティ健全性ファイルにデフォルトを作成できます。
コミュニティ健全性ファイル | 説明 |
---|---|
CONTRIBUTING.md | CONTRIBUTING ファイルは、人々がプロジェクトにどのように貢献すべきかを伝えます。 詳しい情報については、「リポジトリコントリビューターのためのガイドラインを定める」を参照してください。 |
Issue およびプルリクエストテンプレート | Issue およびプルリクエストのテンプレートは、リポジトリで Issue およびプルリクエストを開くときに含める情報をカスタマイズして標準化します。 詳しい情報については、「Issue およびプルリクエストのテンプレートについて」を参照してください。 |
SUPPORT.md | SUPPORT ファイルは、プロジェクトについて支援を受ける方法を伝えるためのものです。 詳しい情報については"プロジェクトへのサポートリソースの追加"を参照してください。 |
デフォルトのライセンスファイルを作成することはできません。 ライセンスファイルは、プロジェクトのクローン時、パッケージ時、またはダウンロード時に含められるよう、個々のリポジトリに追加する必要があります。
デフォルトのファイル用にリポジトリを作成
- ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。
- [Owner] ドロップダウンメニューを使用して、デフォルトファイルを作成する Organization を選択します。
- リポジトリの名前として .github と入力し、任意で説明を入力します。
- リポジトリをパブリックにします。
- [Initialize this repository with a README] を選択します。
- Click Create repository.
- リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートは、
.github/ISSUE_TEMPLATE
というフォルダ内になければなりません。 その他のサポートされているファイルは、リポジトリのルートにある必要があります。 詳細は「新しいファイルを作成する」を参照してください。