Engineering

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

  • GitHub
  • GitHub Organization
  • README
  • プロフィールページ
  • オンボーディング

GitHub Organizationに公開・非公開のプロフィールページを設定する方法を紹介します。.github リポジトリと .github-private リポジトリを使い分けることで、外部向けと内部向けの情報を切り替えて表示できます。

公開プロフィールページの作成

GitHub Organizationのプロフィールページは、個人アカウントと同様にカスタマイズできます。

設定手順は以下の通りです。

  1. Organization内に .github という名前のリポジトリを作成する
  2. そのリポジトリ内に profile/README.md を作成する
  3. README.mdに表示したい内容を記述する

これだけでOrganizationのトップページにREADMEの内容が表示されます。

README.mdの例

弊社のOrganizationで実際に使用しているREADMEです。

# Labee 🐝

Labee is a technology company that primarily focuses on developing and operating its own innovative software services. We also provide supplementary custom software development services to clients.

## Our Focus 🎯

- Developing and operating proprietary software services
- Leveraging the latest technologies to create cutting-edge solutions
- Continuously improving and expanding our service offerings
- Providing exceptional user experiences and delivering value to our users

## Services 🚀

### Proprietary Software Services

Coming soon!

### Custom Software Development (Supplementary)

- Web application development
- Mobile application development
- Cloud infrastructure setup
- Data analysis and visualization
- AI and machine learning integration support

## Get in Touch 📩

Thank you for your interest. Feel free to reach out to us for inquiries or consultations using the following contact information:

- Email: contact@labee.jp
- Website: [https://labee.jp](https://labee.jp)

Let's create a better future together! 🌟

個人アカウントのように派手なプロフィールページにすることも、コントリビュートガイドラインやEntrance Book、採用リンクを記載することもできます。Organizationの規模や目的に合わせてカスタマイズしてください。

非公開プロフィールページの作成

Organizationには、参加メンバーだけが閲覧できる非公開プロフィールページも設定できます。

設定手順です。

  1. Organization内に .github-private という名前のリポジトリを作成する
  2. そのリポジトリ内に profile/README.md を作成する
  3. README.mdに内部向けの情報を記述する

Organizationに参加しているアカウントでアクセスした場合と、外部からアクセスした場合で、表示される内容が自動で切り替わります。

活用例

非公開プロフィールページは社内向けポータルとして活用できます。たとえば以下のような情報を記載しておくと便利です。

  • 開発環境のセットアップ手順
  • 社内ツールへのリンク集
  • オンボーディング資料
  • チームのコミュニケーションチャンネル

ある程度の規模があるOrganizationでは、新メンバーの立ち上がりがスムーズになります。

プロフィールページの設定自体に費用や時間はかかりません。リポジトリの作成と profile/README.md の配置だけで完了します。起業直後のOrganizationでも、外部への情報発信として設定しておく価値はあります。

GitHub OrganizationやGitHub Enterprise Cloudの設定・カスタマイズについて相談がある場合は、ラビーか K@zuki. へ問い合わせてください。