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

CONTRIBUTING や CODE_OF_CONDUCT など、デフォルトのコミュニティ健全性ファイルを作成できます。 デフォルトのファイルは、そのような種類の独自ファイルを持たないアカウントが所有するすべてのリポジトリに使用されます。

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

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 は、次のいずれかの場所にその種類の独自ファイルを持たないアカウントが所有するリポジトリのデフォルトファイルを使用および表示します。

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

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

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

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

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

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

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

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

  1. ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。 新しいリポジトリを作成する選択肢を持つドロップダウン
  2. [Owner] ドロップダウンメニューを使用して、デフォルトファイルを作成する Organization またはユーザアカウントを選択します。 [Owner] ドロップダウンメニュー
  3. リポジトリの名前として .github と入力し、任意で説明を入力します。 リポジトリ作成フィールド
  4. リポジトリのステータスが Public に設定されていることを確認してください (デフォルトファイルのリポジトリをプライベートにすることはできません)。 プライベートまたはパブリックのステータスを選択するラジオボタン
  5. [Initialize this repository with a README] を選択します。 [Initialize this repository with a README] チェックボックス
  6. [Create repository] をクリックします。 Button to create repository
  7. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートとその設定ファイルは、.github/ISSUE_TEMPLATE というフォルダ内になければなりません。 All other supported files may be in the root of the repository, the .github folder, or the docs folder. 詳細は「新しいファイルを作成する」を参照してください。

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?