取締役CTOの小竹（aka tkmru）です。 GitHubには、企業やコミュニティ、OSSプロジェクトなどを組織単位で管理するための、Organizationという機能があります。先日、弊社のOrganizationのプロフィールにREADMEを設定しました。この記事では、OrganizationにREADMEを設定する方法、記載内容について紹介します。

OrganizationのプロフィールにREADMEを設定する方法

次の手順で、OrganizationにREADMEを設定できます。

所属しているOrganizationに.githubという名前のリポジトリを作成します。
.github リポジトリ内にprofileフォルダを作成します。
profileフォルダ内にREADME.mdを作成し、Markdown形式で内容を記載します。
README.mdへの変更をコミットします。
問題なければ、リポジトリを公開します。

docs.github.com

READMEに記載する内容

READMEには、活動内容や目的など、OrganizationのGitHub リポジトリへの訪問者に伝えたい情報を記載します。 Markdown形式で記述できるので、見出しやリンク、画像などを使って各種情報を分かりやすく伝えられます。例えば、次のような内容を記載できます。

Organizationの目的
Organizationの活動内容
Organizationの連絡先

弊社のREADMEでは、次の内容を記載しています。

About Us（自己紹介）
Links（各種リンク）
License（OSSのライセンス情報）

参考に弊社のREADME.mdをご覧ください。 About Usには、弊社では脆弱性診断サービスを提供していることや、脆弱性診断のためのOSSツールをGitHub上で公開し、コミュニティに貢献していきたい旨を記載しています。

github.com

まとめ

OrganizationにREADMEを設定することで、どういった活動を行なっている組織なのか、訪問者に分かりやすく伝えることができます。個人ユーザだとプロフィールにREADMEを設定している方が結構多い印象ですが、日本企業ではOSSを公開している企業であっても、OrganizationにREADMEを設定していないことが多いです。インターネットでのプレゼンスを高めるためにも、READMEを設定してみてはいかがでしょうか。ぜひ、あなたのOrganizationでもREADMEを作成し、組織の魅力を発信してみてください。