GitHub README Statsで分かること
GitHub README Statsはユーザー名からSVGカードを生成します。メインカードにはスター、コミット、プルリクエスト、Issue、貢献リポジトリ、ランクなどを表示でき、別のカードで使用言語の傾向も示せます。
ただし数字だけで技術力を判断することはできません。非公開活動の設定、fork、所有関係、生成ファイル、キャッシュやAPI制限によって表示は変わります。カードはプロフィールを理解する入口として使います。
カードは自己紹介や代表プロジェクトの後に置くと自然です。用途別にはStreak Statsガイド、Trophyガイド、READMEテンプレート、立体表示にはGitHub Cityを使い分けます。
カードは会話の入口であり、プロジェクト説明が結論です。課題、担当、技術的な判断、確認できるコードを示すことで統計に意味が生まれます。
統計カードを追加・設定する手順
最小のURLで表示を確認し、オプションを一つずつ追加すると問題を切り分けやすくなります。
プロフィールREADMEを開く
ユーザー名と同名の公開リポジトリにREADMEを用意し、自己紹介や代表作の下へ配置します。
正しいユーザー名を指定する
公式URLのusernameを置き換え、まず画像URL単体で開いて確認します。
読みやすいテーマを選ぶ
実際のREADME背景で十分なコントラストを確保し、派手なウィジェットを重ねません。
必要な指標だけ残す
アイコンや非表示設定は、読み手の理解を助ける場合に限定します。
どのプロフィール可視化を選ぶか
それぞれ答える質問が異なります。主役を1つ、補助を1つまでにすると読みやすくなります。
| 可視化 | 向いている用途 | 設定 | 主な注意点 | 置き場所 |
|---|---|---|---|---|
| 統計カード | 活動の概要 | ユーザー名付き画像URL | 文脈が必要 | 自己紹介の後 |
| 使用言語カード | 言語構成 | 別カードURL | スキル順位ではない | 統計カードの近く |
| Streak Stats | 最近の継続性 | 専用サービス | 毎日の活動を強調しすぎる | 必要な場合のみ |
| GitHub City | 貢献カレンダーの3D探索 | ブラウザーツール | 作品の証拠の代わりではない | 詳しい表示へのリンク |
よくある表示トラブル
原因の多くはユーザー名、URL、サービス状態、公開範囲、指標の解釈です。
カードが表示されない
画像URLを直接開き、ユーザー名と設定を確認し、オプションを外して公式Issueも確認します。
数字が少なく見える
対象リポジトリ、非公開活動、fork、キャッシュ、API制限を確認します。
テーマが読みにくい
実際のREADME背景で確認し、透明度と文字色のコントラストを上げます。
言語比率が不自然
生成コード、Notebook、vendorファイル、大規模リポジトリの影響を考慮します。
ウィジェットより実績を中心にする
プロフィールでは、何を作り、どんな成果があり、どのコードを見るべきかを先に伝えます。統計カードは補助情報として有効ですが、何枚も並べるとプロジェクトより目立ちます。
全体構成はREADMEテンプレートガイドで整え、GitHub Cityは貢献履歴を立体的に見せる追加リンクとして使います。
デスクトップとスマートフォン幅でREADMEを確認し、同じ情報を繰り返すカードや横に広すぎる配置を減らします。
おすすめ構成
短い自己紹介、2〜3件の代表プロジェクト、統計カード1枚、必要なら補助可視化1つ。残りは分かりやすいリンクにします。
よくある質問
GitHub公式機能ですか？
いいえ。プロフィールREADMEはGitHubの機能ですが、カード生成は独立したオープンソースプロジェクトです。
READMEに統計を追加する方法は？
プロフィールリポジトリのREADMEにユーザー名入り画像Markdownを追加し、プレビューで確認します。
非公開コミットが出ないのはなぜ？
公開設定、取得可能なAPIデータ、カードの設定と実装に左右されます。
Stats・Streak・Trophyのどれを使う？
概要はStats、継続性はStreak、節目の表現はTrophyです。目的に合うものだけ選びます。
GitHub Cityと併用できますか？
はい。カードを短い要約、GitHub Cityを3Dの詳しい探索として使い分けられます。