ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

所属する Organization 用にデフォルトのコミュニティ健全性ファイルを作成

所属する Organization 用に、CONTRIBUTING や CODE_OF_CONDUCT など、デフォルトのコミュニティ健全性ファイルを作成できます。 デフォルトのファイルは、そのような独自ファイルを持たない Organization 内のあらゆるパブリックリポジトリに使用されます。

このガイドの内容

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

所属する Organization 用に作成したデフォルトのコミュニティ健全性ファイルを、Organization が所有している .github という名のパブリックリポジトリのルートに追加できます。

以下のどこにもそのような種類の独自ファイルを持たない Organization 内にあるどのパブリックリポジトリのデフォルトのファイルでも、GitHub は使用し表示します。

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

たとえば、独自の CONTRIBUTING ファイルを持たないパブリックリポジトリに Issue やプルリクエストを作成する人は誰でも、デフォルトの CONTRIBUTING ファイルへのリンクが見られます。 If a repository has any files in its own .github/ISSUE_TEMPLATE folder, including issue templates or a config.yml file, none of the contents of the default .github/ISSUE_TEMPLATE folder will be used.

デフォルトのファイルは .github リポジトリにのみ格納されるものであって、クローン、パッケージ、リポジトリ個別のダウンロードには含まれません。

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

以下のコミュニティ健全性ファイルについては、Organization 全体に関わるデフォルト設定を作成できます:

Community health file 説明
CODE_OF_CONDUCT.md A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "Adding a code of conduct to your project."
CONTRIBUTING.md A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors."
FUNDING.yml A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. 詳細は「リポジトリにスポンサーボタンを表示する」を参照してください。
Issue and pull request templates and config.yml Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "About issue and pull request templates."
SECURITY.md A SECURITY file gives instructions for how to responsibly report a security vulnerability in your project. For more information, see "Adding a security policy to your repository."
SUPPORT.md A SUPPORT file lets people know about ways to get help with your project. 詳しい情報については"プロジェクトへのサポートリソースの追加"を参照してください。

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

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

  1. 任意のページの右上で をクリックし、続いて [New repository] をクリックします。

    新規リポジトリの作成オプションを持つドロップダウン

  2. [Owner] ドロップダウンメニューを使用して、デフォルトのファイルを作成したい Organization を選択します。

    [Owner] ドロップダウンメニュー

  3. リポジトリの名前として .github と入力し、任意で説明を入力します。

    リポジトリ作成フィールド

  4. リポジトリをパブリックにします。

    プライベートまたはパブリックのステータスを選択するラジオボタン

  5. Select Initialize this repository with a README.

    Initialize this repository with a README checkbox

  6. Click Create repository.

  7. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue templates and their configuration file must be in a folder called .github/ISSUE_TEMPLATE. その他のサポートされているファイルは、リポジトリのルートにある必要があります。 詳細は「新しいファイルを作成する」を参照してください。

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください