Préparez le bon fichier
Les consignes actuelles de GitHub acceptent les fichiers PNG, JPG ou GIF de moins de 1 MB. Elles recommandent au moins 640 × 320 pixels, avec 1280 × 640 pour un affichage optimal. Partez du plus grand canevas au format 2:1, puis vérifiez la lisibilité à une taille nettement réduite.
Pour un validateur CSV fictif, une composition claire pourrait afficher le nom du projet, « Vérifiez les fichiers CSV avant importation » et un exemple simple reliant une entrée à une erreur. Évitez de condenser une session de terminal entière dans une miniature. Éloignez les textes importants des bords au cas où une plateforme de partage recadrerait l’image.
Envoyez l’image et vérifiez le lien partagé
Ouvrez Settings du dépôt, repérez Social preview, choisissez Edit et envoyez l’image. Partagez l’URL publique du dépôt à l’endroit où votre public la verra. Vérifiez le résultat sur cette plateforme ; un envoi réussi ne garantit pas que chaque plateforme remplace immédiatement un aperçu en cache.
- Confirmez que l’image correspond au dépôt que vous partagez.
- Vérifiez le format, les dimensions en pixels et la taille du fichier avant l’envoi.
- Utilisez un contraste lisible ; examinez les illustrations transparentes sur des fonds clairs et sombres.
- Si l’image est périmée, vérifiez le paramètre enregistré du dépôt et examinez le cache de la plateforme de destination.
Gardez un aperçu cohérent avec le projet
Utilisez le même nom et le même objectif dans l’image, le README et l’annonce de version. Si une capture montre une fonctionnalité expérimentale, indiquez-le ou utilisez plutôt un parcours stable. N’ajoutez pas de nombres de Stars, de logos de clients ou d’affirmations de performances inventés.
Réexaminez l’image lorsque le cas d’usage principal du projet change. Un aperçu est un support de communication, pas une garantie indépendante de classement, de taux de clics ou de Stars GitHub.
Questions fréquentes
Est-ce la même chose que l’avatar du propriétaire du dépôt ?
Non. L’avatar du propriétaire identifie le compte. Un aperçu social personnalisé représente un projet particulier lorsque son lien est partagé.
L’aperçu peut-il avoir un fond transparent ?
GitHub prend en charge la transparence PNG. Vérifiez le contraste sur différents fonds ; un fond uni est un choix pratique si l’apparence de la destination est incertaine.
Pourquoi vois-je encore l’ancien aperçu après l’envoi ?
Vérifiez d’abord que la nouvelle image est enregistrée dans le bon dépôt. Les plateformes de partage peuvent mettre les aperçus en cache ; leur actualisation est indépendante du paramètre du dépôt.