既定のコミュニティ正常性ファイルの作成

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

この記事の内容

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

デフォルトのコミュニティ正常性ファイルは、健全で協調的なオープンソース Project をメインするためのガイダンスとテンプレートを提供する定義済みのファイルのセットです。 既定のコミュニティ正常性ファイルは、.github という名前のパブリック リポジトリ、リポジトリのルート、または docs や .github フォルダーに追加できます。 これらのファイルは、Project の開発とコミュニティの相互作用のさまざまな側面を自動化および標準化するのに役立ちます。 これらは、オープンソース Project の透明性、優れたプラクティス、コラボレーションを促進するために不可欠です。

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

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

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

既定のファイルは、.github リポジトリにのみ格納されるため、ファイル ブラウザーまたは Git 履歴には表示されず、個別のリポジトリのクローン、パッケージ、ダウンロードには含まれません。

リポジトリ メンテナとして、人がプロジェクトを利用し、プロジェクトに貢献できるよう、推奨されるコミュニティ標準をプロジェクトが満たしているかを確認するため、コミュニティ標準チェックリストを使うことができます。 詳しくは、「パブリックリポジトリのコミュニティプロフィールについて」を参照してください。

サポートされるファイルのタイプ

次のコミュニティ正常性ファイルのデフォルトを、Organization または個人用アカウントに作成できます。

コミュニティ正常性ファイル | 説明 --- | --- CODE_OF_CONDUCT.md | CODE_OF_CONDUCT ファイルでは、コミュニティに参加する方法の標準が定義されています。 詳しくは、「プロジェクトへの行動規範の追加」をご覧ください。 CONTRIBUTING.md | CONTRIBUTING ファイルでは、プロジェクトに投稿する方法が示されています。 詳しくは、「リポジトリコントリビューターのためのガイドラインを定める」をご覧ください。 ディスカッション カテゴリ フォーム | ディスカッション カテゴリ フォームでは、コミュニティ メンバーがリポジトリで新しいディスカッションを開くときに使用できるテンプレートをカスタマイズできます。 詳しくは、「ディスカッション カテゴリ フォームの作成」をご覧ください。 FUNDING.yml | FUNDING ファイルには、オープンソース プロジェクトでの資金調達オプションをさらに多く表示するためのスポンサー ボタンが表示されます。 詳しくは、「リポジトリにスポンサーボタンを表示する」をご覧ください。 GOVERNANCE.md | GOVERNANCE ファイルは、プロジェクトの管理方法を人々に知らせるものです。 たとえば、プロジェクト ロールと意思決定の方法について説明する可能性があります。 issue と pull request のテンプレートおよび config.yml | issue と pull request のテンプレートでは、自分のリポジトリで共同作成者が issue や pull request を開くときに含めてほしい情報をカスタマイズおよび標準化します。 詳しくは、「Issueとプルリクエストのテンプレートについて」を参照してください。 SECURITY.md | SECURITY ファイルでは、プロジェクトおよびファイルにハイパーリンクされている説明でのセキュリティ脆弱性を報告する方法の手順が示されます。 詳しくは、「リポジトリへのセキュリティ ポリシーの追加」を参照してください。 SUPPORT.md | SUPPORT ファイルでは、プロジェクトに関するヘルプを得る方法がわかるようにします。 詳しくは、「プロジェクトへのサポートリソースの追加」を参照してください。

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

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

  1. ページの右上隅で を選択し、 [新しいリポジトリ] をクリックします。

    新しいアイテムを作成するオプションを示す GitHub ドロップダウン メニューのスクリーンショット。 [新しいリポジトリ] というメニュー項目が濃いオレンジ色の枠線で囲まれています。

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

    新しい GitHub リポジトリの所有者メニューのスクリーンショット。 メニューには、octocat と github の 2 つのオプションが表示されます。

  3. [リポジトリ名] フィールドに「 .github」と入力します。

  4. あるいは、[説明] フィールドに説明を入力します。

  5. リポジトリの状態が [パブリック] に設定されていることを確認します。 既定のファイルのリポジトリをプライベートにすることはできません。

  6. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。

  7. [Create repository] (リポジトリの作成) をクリックします。

  8. リポジトリの中に、サポートされているコミュニティ健全性ファイルの 1 つを作成します。 Issue テンプレートとその構成ファイルは、.github/ISSUE_TEMPLATE という名前のフォルダーに存在する必要があります。 他のすべてのサポートされるファイルは、リポジトリのルート、.github フォルダー、または docs フォルダーに置くことができます。 詳しくは、「新しいファイルの作成」を参照してください。