適切なファイルを用意する
GitHub の現在の案内では、1 MB 未満の PNG、JPG、GIF が利用できます。最低 640 × 320 ピクセル、最適な表示には 1280 × 640 が推奨されています。大きい方の 2:1 キャンバスで作り、かなり縮小しても読めるか確認しましょう。
架空の CSV 検証ツールなら、プロジェクト名、「インポート前に CSV ファイルをチェック」、入力からエラーまでの簡単な例を示すと明確です。端末操作の全体をサムネイルに詰め込まないでください。共有先で切り抜かれる場合に備え、重要な文字は端から離します。
アップロードして共有リンクを確認する
リポジトリの Settings を開き、Social preview を探して Edit を選び、画像をアップロードします。読者が見る共有先に公開リポジトリの URL を投稿し、その場所で結果を確認しましょう。アップロードに成功しても、すべてのプラットフォームがキャッシュ済みプレビューを直ちに置き換えるとは限りません。
- 共有するリポジトリ用の画像であることを確認します。
- アップロード前に形式、ピクセル寸法、ファイルサイズを確認します。
- 読みやすいコントラストにし、透明な画像は明るい背景と暗い背景の両方で確認します。
- 画像が古いままなら、保存されたリポジトリ設定を確認し、共有先のキャッシュを調べます。
プレビューをプロジェクトと一致させる
画像、README、リリース告知では同じプロジェクト名と目的を使います。スクリーンショットが実験的機能を示すなら、その旨を記すか、安定した手順の画像にします。架空の Star 数、顧客ロゴ、性能に関する主張を加えないでください。
中心となる利用場面が変わったら画像を見直します。プレビューは情報を伝える素材であり、順位、クリック率、GitHub の Star を保証する別の仕組みではありません。
よくある質問
リポジトリ所有者のアバターと同じですか?
違います。所有者のアバターはアカウントを識別します。カスタムのリポジトリプレビューは、リンク共有時に特定のプロジェクトを表します。
プレビューに透明な背景を使えますか?
GitHub は PNG の透明度に対応しています。背景ごとのコントラストを確認しましょう。共有先の表示が不明な場合は、単色背景が実用的です。
アップロード後も古いプレビューが見えるのはなぜですか?
まず、新しい画像が正しいリポジトリに保存されているか確認します。共有プラットフォームはプレビューをキャッシュすることがあり、その更新動作はリポジトリ設定とは別です。