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

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

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

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

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

Organization またはユーザアカウントが所有する .github というパブリックリポジトリのルートにデフォルトのコミュニティ健全性ファイルを追加できます。

GitHubは、次のいずれかの場所にそのタイプの独自のファイルを持たないアカウントが所有するパブリックリポジトリのデフォルトファイルを使用および表示します。

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

たとえば、独自の CONTRIBUTING ファイルを持たないパブリックリポジトリに Issue やプルリクエストを作成する人は誰でも、デフォルトの CONTRIBUTING ファイルへのリンクが見られます。 リポジトリの独自の .github/ISSUE_TEMPLATE フォルダに Issue テンプレートや config.yml ファイルなどのファイルがある場合、デフォルトの .github/ISSUE_TEMPLATEフォルダのコンテンツは使用されません。

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

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

Organization または次のコミュニティ健全性ファイルのユーザアカウントにデフォルトを作成できます。

コミュニティ健全性ファイル 説明
CODE_OF_CONDUCT.md CODE_OF_CONDUCT ファイルは、コミュニティへの参加方法の標準を定義します。 詳しい情報については、「プロジェクトへの行動規範の追加」を参照してください。
CONTRIBUTING.md CONTRIBUTING ファイルは、人々がプロジェクトにどのように貢献すべきかを伝えます。 詳しい情報については、「リポジトリコントリビューターのためのガイドラインを定める」を参照してください。
FUNDING.yml FUNDING ファイルでは、あなたのオープンソースプロジェクトに対する資金提供のオプションについての認知度を高めるため、リポジトリにスポンサーボタンが表示されます。 詳細は「リポジトリにスポンサーボタンを表示する」を参照してください。
Issue およびプルリクエストテンプレートおよびconfig.yml Issue およびプルリクエストのテンプレートは、リポジトリで Issue およびプルリクエストを開くときに含める情報をカスタマイズして標準化します。 詳しい情報については、「Issue およびプルリクエストのテンプレートについて」を参照してください。
SECURITY.md SECURITY ファイルには、プロジェクトのセキュリティ脆弱性について責任を持って報告する方法が記載されています。 詳しい情報については「リポジトリへのセキュリティポリシーの追加」を参照してください。
SUPPORT.md SUPPORT ファイルでは、プロジェクトについて支援を受ける方法を知ることができます。 詳しい情報については"プロジェクトへのサポートリソースの追加"を参照してください。

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

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

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

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

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

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

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

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

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

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

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

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

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

  7. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートとその設定ファイルは、.github/ISSUE_TEMPLATE というフォルダ内になければなりません。 その他のサポートされているファイルは、リポジトリのルートにある必要があります。 詳細は「新しいファイルを作成する」を参照してください。

担当者にお尋ねください

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

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