GitHubのプロフィールをREADMEでプロっぽく作る方法
最終更新日
GitHubを周遊していると、ときどきやたら豪華なプロフィールを持つエンジニアにたどり着くことがあります。
彼ら彼女らのプロフィールはプロフェッショナルを感じられて「すごい人」感を演出しています。
彼ら彼女らのプロフィールはプロフェッショナルを感じられて「すごい人」感を演出しています。
実際のすごさは置いておいて、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と同じものが表示されています。
プロフィールページを見てみましょう。下記のように、該当のリポジトリのREADMEと同じものが表示されています。
ここから改良していきましょう。
GitHubプロフィールの内容を決める
他のエンジニアのプロフィールを参考に、内容のアイディアに使えそうなリストを列挙します。
- 簡単な自己紹介（絵文字利用率高い）
- 経歴
- リストで興味・関心やメイン技術について紹介
- スキルセット
- ファーストビューでインパクトのある画像や動画
- Stats（どの程度GitHubを使っているかの統計）
- コミッターになっているOSS
- 個人開発プロジェクト
- GitHub Sponsorを募集するリンク
- GitHub Sponsorでスポンサーになっている企業へのリンク
- SNS
- アスキーアート
- ソースコードで自己紹介
- プログラミング関係ない趣味や特技
マークダウンとウィジェットで構成する
基本的にマークダウン形式のドキュメントなので、GitHubで使えるマークダウンはすべて対応しています。さらに絵文字も対応しています。
便利なウィジェット集
多くの先人がGitHubプロフィールを充実させるのに便利なウィジェットを公開しています。
参考になるリンクを羅列します。
参考になるリンクを羅列します。
- GitHub Readme Stats : Stats CardやTop Language Cardを提供している。GitHub API制限の関係で自分の環境でデプロイしたほうが安心。
- GitHub Profile Summary Cards : GitHubの活動履歴のグラフ化。GitHub Actionsもある。
- GitHub Profilenator : READMEジェネレーター。
- Shields.io : バッジを表示してくれる。
- GitHub Profile Trophy : トロフィーを表示できる。
- Skill Icons : スキルセットをアイコンで表示できる。
- Awesome GitHub Profile READMEs : みんなのGitHub Profile集。
やりすぎ注意
「GitHub Profileでいろんな表現できる」と紹介してはいますが、あくまでドキュメントであることを忘れないようにしましょう。
プロダクトのドキュメントを綴る際、キラキラしていればわかりやすいということはありません。もちろん、自身の趣味や嗜好を存分に発揮して問題ありませんが、読み手にとって何が必要かを最短で考えることを優先するべきです。
プロダクトのドキュメントを綴る際、キラキラしていればわかりやすいということはありません。もちろん、自身の趣味や嗜好を存分に発揮して問題ありませんが、読み手にとって何が必要かを最短で考えることを優先するべきです。
転職や案件獲得に役立てるのであれば、なおさらすっきりと伝えたい内容を伝えられるほうがベターです。
この前提だと以下の項目でまとめると良さそうです。
この前提だと以下の項目でまとめると良さそうです。
- シンプルな自己紹介と経歴
- スキルセット
- TwitterやLinkedInのような連絡用SNS（GitHubアカウントに設定していたら要らないかも）
- （あれば）コントリビューターになっているOSS
- （あれば）個人開発プロジェクト
作ってみた
運営者である田邉も作ってみました。
参考に見てみてください。
参考に見てみてください。
こういった短時間かつお金をかけずにできる小さな積み重ねが、時間をかけて効いてくる可能性もあるので、ぜひ自分のGitHub Profileを作ってみましょう。