GitHubには username/.github というように .github リポジトリというメタファイルを置くリポジトリが作れます。 たとえば、 username/.github リポジトリに CODE_OF_CONDUCT.md ファイルを置くと、usernameのすべてのリポジトリにそのファイルが反映されます。

CODE_OF_CONDUCT.mdをおいた場合は、次のようにIssueを作る際になどにHelpful resourcesにリンクが表示されるようになります。

image

もともとこの機能はOrganization(個人アカウントではない)のみで動いていたと思いますが、いつのまにか個人アカウントでも.githubリポジトリが機能するようになっていました。

次のページはOrganizationの場合ですが.githubリポジトリで特別な意味のあるファイルがまとめられています。

.githubに設定できるファイル

2021-09-04時点では、次のようなファイルが認識されます。 最新のサポート対象はCreating a default community health file - GitHub Docsを参照してください。

  • CODE_OF_CONDUCT.md: プロジェクトの行動規範について書かれたファイル
  • CONTRIBUTING.md: プロジェクトのコントリビュートガイド
    • プロジェクトごとに普通は異なるので、個人アカウントの共通ファイルとしては使いにくいかもしれません
  • FUNDING.yml: GitHub Sponsorsなどのスポンサー支援を促すボタンの定義ファイル
  • Issue / Pull Template: IssueとPull Requestのテンプレートファイル
  • SECURITY.md: セキュリティレポートはIssueにすると修正前にPublicになってしまうので、セキュリティ的な問題の報告先を書くファイルです
  • SUPPORT.md: チャットなどのサポートを受けれる場所を案内するファイル

.github リポジトリを使うことで、自分が持っているリポジトリ全てに一括で設定できるので便利です。

たとえば、.githubリポジトリにFUNDING.ymlを置くと、 個別のリポジトリに.github/FUNDING.ymlを作らなくてもスポンサーボタンが表示できます。

sponsor

自分の.githubリポジトリは次のようになっています。

リポジトリごとに設定が異なる場合は、リポジトリの.github/ディレクトリに同名のファイルをコミットすれば.github/ディレクトリが優先されます。