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