デフォルトのコミュニティ健全性ファイルについて
You can add default community health files to the root of a public repository called .github
that is owned by an organization.
GitHub Enterprise Serverは、次のいずれかの場所にそのタイプの独自のファイルがないアカウントのパブリックリポジトリについては、デフォルトファイルを使用および表示します。
- リポジトリのルート
.github
フォルダdocs
フォルダ
たとえば、独自の CONTRIBUTING ファイルを持たないパブリックリポジトリに Issue やプルリクエストを作成する人は誰でも、デフォルトの CONTRIBUTING ファイルへのリンクが見られます。 If a repository has any files in its own .github/ISSUE_TEMPLATE
folder none of the contents of the default .github/ISSUE_TEMPLATE
folder will be used.
デフォルトのファイルは .github
リポジトリにのみ格納されるものであって、クローン、パッケージ、リポジトリ個別のダウンロードには含まれません。
サポートされているファイルの種類
You can create defaults in your organization for the following community health files:
コミュニティ健全性ファイル | 説明 |
---|---|
CONTRIBUTING.md | CONTRIBUTING ファイルは、人々がプロジェクトにどのように貢献すべきかを伝えます。 For more information, see "Setting guidelines for repository contributors." |
Issue and pull request templates | Issue およびプルリクエストのテンプレートは、リポジトリで Issue およびプルリクエストを開くときに含める情報をカスタマイズして標準化します。 For more information, see "About issue and pull request templates." |
SUPPORT.md | SUPPORT ファイルは、プロジェクトについて支援を受ける方法を伝えるためのものです。 詳しい情報については"プロジェクトへのサポートリソースの追加"を参照してください。 |
デフォルトのライセンスファイルを作成することはできません。 ライセンスファイルは、プロジェクトのクローン時、パッケージ時、またはダウンロード時に含められるよう、個々のリポジトリに追加する必要があります。
デフォルトのファイル用にリポジトリを作成
- ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。
- Use the Owner drop-down menu, and select the organization you want to create default files for.
- リポジトリの名前として .github と入力し、任意で説明を入力します。
- Make sure the repository status is set to Public (a repository for default files cannot be private).
- [Initialize this repository with a README] を選択します。
- Click Create repository.
- リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue templates must be in a folder called
.github/ISSUE_TEMPLATE
. その他のサポートされているファイルは、リポジトリのルートにある必要があります。 詳細は「新しいファイルを作成する」を参照してください。