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

Creating a default community health file

You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any public repository owned by the account that does not contain its own file of that type.

ここには以下の内容があります:

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

You can add default community health files to the root of a public repository called .github that is owned by an organization or user account.

GitHub will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places:

  • リポジトリのルート
  • .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 リポジトリにのみ格納されるものであって、クローン、パッケージ、リポジトリ個別のダウンロードには含まれません。

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

You can create defaults in your organization or user account for the following community health files:

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. 詳しい情報については"プロジェクトへのサポートリソースの追加"を参照してください。

You cannot create a default license file. ライセンスファイルは、プロジェクトのクローン時、パッケージ時、またはダウンロード時に含められるよう、個々のリポジトリに追加する必要があります。

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

  1. ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。

    新しいリポジトリを作成する選択肢を持つドロップダウン

  2. Use the Owner drop-down menu, and select the organization or user account you want to create default files for.

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

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

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

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

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

  5. [Initialize this repository with a README] を選択します。

    [Initialize this repository with a README] チェックボックス

  6. [Create repository] をクリックします。

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

担当者にお尋ねください

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

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