GitHub OrganizationのプロフィールページにREADME.mdを設定する

最近知ったんですが、GitHubのOrganizationのプロフィールページにはREADME.mdを設定することができます。

例えばMicrosoftのOrganizationには、OpenSource Projectへの参加方法についてのリンクが主に記載されています。

公式ドキュメントは、ここになります。

https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-public-organization-profile-readme

.githubリポジトリのprofile/README.mdを配置すると表示されるような仕組みでした。

Microsoftの場合だと、 https://github.com/microsoft/.github/blob/main/profile/README.md に対応するファイルがあります。
他のOrganizationに実際に適用してみたところ問題なく設定できたので、公式で対応してるものになりそうです。

GitHub,CircleCI-PublicやStudistでも同様の設定がされているようです。

github.com

設定する内容としては、OSSポリシーが適切そうですかね。

個人のプロフィールには設定できるのか？

個人のプロフィールページは、Organizationとは全く別のやり方です。
.githubリポジトリではなく自ユーザ名のリポジトリを作成して、ルートにREADME.mdを配置すれば良いようです。

zenn.dev

Organizationのプロフィールページを書く時に気をつけることある？

あんまりプラクティスのようなものは見つけられなかったんですが、しいて気をつけることがあるとすれば、README.mdに記載するリンクです。
例えば、.github リポジトリが以下のような構成であるとします。

.
├── images
│   └── logo.png
└── profile
    └── README.md

この時、READMEに画像を表示させるために![logo](../images/logo.png)といった書き方でリンクさせると、リポジトリやプレビューで見てる分には問題ないですが、
Organizationのプロフィールページでは表示されません。
表示させたい場合は、URLを指定して参照させます。

誤 ... ![logo](.../images/logo.png)
正 ... ![logo](https://github.com/corrupt952/.github/images/logo.png?raw=true)

.github-privateリポジトリというのもあるので、うまく使い分けられればポータルページのようにも使えるかもしれません。