Projektleitfäden

GitHub-Vorschaubild für soziale Medien: Größe, Einrichtung und Checkliste

Die Social Preview eines Repositorys ist das Bild, das beim Teilen seines Links erscheinen kann. Erkläre damit das Projekt auf einen Blick: ein kurzer Name, ein nützliches Versprechen und ein erkennbares Beispiel. Sie ergänzt das README, statt es zu ersetzen.

GitHubStart-Redaktion · Aktualisiert

Bereite die richtige Datei vor

GitHubs aktuelle Vorgaben akzeptieren PNG-, JPG- oder GIF-Dateien unter 1 MB. Empfohlen werden mindestens 640 × 320 Pixel und für die beste Darstellung 1280 × 640. Beginne mit der größeren Arbeitsfläche im Verhältnis 2:1 und prüfe anschließend die Lesbarkeit bei deutlich kleinerer Darstellung.

Für einen fiktiven CSV-Validator könnte ein klares Layout den Projektnamen, „CSV-Dateien vor dem Import prüfen“ und ein einfaches Beispiel von Eingabe zu Fehlermeldung zeigen. Presse keine vollständige Terminalsitzung in ein Vorschaubild. Halte wichtige Texte von den Rändern fern, falls eine Plattform das Bild beim Teilen zuschneidet.

Lade das Bild hoch und prüfe den geteilten Link

Öffne die Settings des Repositorys, suche Social preview, wähle Edit und lade das Bild hoch. Teile die öffentliche Repository-URL dort, wo dein Publikum sie sehen wird. Prüfe das Ergebnis auf dieser Plattform; ein erfolgreicher Upload garantiert nicht, dass jede Plattform eine zwischengespeicherte Vorschau sofort ersetzt.

  • Bestätige, dass das Bild zum geteilten Repository gehört.
  • Prüfe Dateiformat, Pixelabmessungen und Dateigröße vor dem Upload.
  • Verwende gut lesbare Kontraste; prüfe transparente Grafiken auf hellen und dunklen Hintergründen.
  • Wenn das Bild veraltet ist, kontrolliere die gespeicherte Repository-Einstellung und untersuche den Cache der Zielplattform.

Halte die Vorschau mit dem Projekt in Einklang

Verwende denselben Projektnamen und Zweck im Bild, im README und in der Release-Ankündigung. Zeigt ein Screenshot eine experimentelle Funktion, kennzeichne sie oder nutze stattdessen einen stabilen Ablauf. Füge keine erfundenen Star-Zahlen, Kundenlogos oder Leistungsversprechen hinzu.

Überarbeite das Bild, wenn sich der zentrale Anwendungsfall des Projekts ändert. Eine Vorschau ist ein Kommunikationsmittel, keine eigenständige Garantie für Rankings, Klickraten oder GitHub Stars.

Häufige Fragen

Ist das dasselbe wie der Avatar des Repository-Eigentümers?

Nein. Der Avatar des Eigentümers kennzeichnet das Konto. Eine individuelle Social Preview repräsentiert ein bestimmtes Projekt, wenn dessen Link geteilt wird.

Kann die Vorschau einen transparenten Hintergrund verwenden?

GitHub unterstützt PNG-Transparenz. Prüfe den Kontrast auf unterschiedlichen Hintergründen; ein einfarbiger Hintergrund ist praktisch, wenn das Erscheinungsbild am Ziel unbekannt ist.

Warum sehe ich nach dem Upload noch die alte Vorschau?

Prüfe zuerst, ob das neue Bild im richtigen Repository gespeichert wurde. Plattformen können Vorschauen zwischenspeichern; deren Aktualisierung erfolgt unabhängig von der Repository-Einstellung.

Quellen