GitHubのプロフィールをREADMEでプロっぽく作る方法

GitHubを周遊していると、ときどきやたら豪華なプロフィールを持つエンジニアにたどり着くことがあります。
彼ら彼女らのプロフィールはプロフェッショナルを感じられて「すごい人」感を演出しています。

実際のすごさは置いておいて、GitHubアカウントを持っている人はかっこいいプロフィール作りに挑戦してみると良いです。もちろんセルフブランディング的な意味合いもありますが、気持ちが鼓舞され、GitHubにアクションする意欲が倍増されます。
今回はGitHubプロフィール作成の手順を紹介していきます。

自分のプロフィールを出すリポジトリ作成

まずはリポジトリ作成です。
画面右上にある「＋」ボタンからNew repositoryを押下します。

続いて、Repository nameの部分に自身のGitHubユーザー名を入力しましょう。こうすることで、GitHubはこのリポジトリのREADMEをGitHubプロフィールとして認識します。

READMEを作成してみる

自分のパソコン内に該当のリポジトリを管理するディレクトリを作りましょう。今回はサンプルとしてgithubというディレクトリを作ります。

mkdir github && cd github

該当のリポジトリでプロフィールが正しく表示されるか試します。

$ echo "# kt2763" >> README.md
$ git init
$ git add README.md
$ git commit -m "first commit"
$ git remote add origin https://github.com/kt2763/kt2763.git
$ git push -u origin main

該当のリポジトリのコードを見ると、通常と同じくREADMEが追加されています。
プロフィールページを見てみましょう。下記のように、該当のリポジトリのREADMEと同じものが表示されています。

ここから改良していきましょう。

GitHubプロフィールの内容を決める

他のエンジニアのプロフィールを参考に、内容のアイディアに使えそうなリストを列挙します。

マークダウンとウィジェットで構成する

基本的にマークダウン形式のドキュメントなので、GitHubで使えるマークダウンはすべて対応しています。さらに絵文字も対応しています。

便利なウィジェット集

多くの先人がGitHubプロフィールを充実させるのに便利なウィジェットを公開しています。
参考になるリンクを羅列します。

やりすぎ注意

「GitHub Profileでいろんな表現できる」と紹介してはいますが、あくまでドキュメントであることを忘れないようにしましょう。
プロダクトのドキュメントを綴る際、キラキラしていればわかりやすいということはありません。もちろん、自身の趣味や嗜好を存分に発揮して問題ありませんが、読み手にとって何が必要かを最短で考えることを優先するべきです。

転職や案件獲得に役立てるのであれば、なおさらすっきりと伝えたい内容を伝えられるほうがベターです。
この前提だと以下の項目でまとめると良さそうです。

作ってみた

運営者である田邉も作ってみました。
参考に見てみてください。

こういった短時間かつお金をかけずにできる小さな積み重ねが、時間をかけて効いてくる可能性もあるので、ぜひ自分のGitHub Profileを作ってみましょう。