Poradniki projektów

Obraz podglądu społecznościowego GitHub: rozmiar i konfiguracja

Podgląd społecznościowy repozytorium to obraz, który może pojawić się przy udostępnianiu jego linku. Użyj krótkiej nazwy, jednego użytecznego komunikatu i rozpoznawalnego przykładu, aby szybko wyjaśnić projekt. To uzupełnienie README, a nie jego zamiennik.

Zespół redakcyjny GitHubStart · Zaktualizowano

Przygotuj właściwy plik

Obecne wytyczne GitHub dopuszczają pliki PNG, JPG lub GIF o rozmiarze poniżej 1 MB. Zalecają co najmniej 640 × 320 pikseli, a dla najlepszego wyświetlania 1280 × 640. Zacznij od większego płótna 2:1, a następnie sprawdź czytelność po znacznym pomniejszeniu.

Dla fikcyjnego walidatora CSV czytelny układ może zawierać nazwę projektu, hasło „Sprawdź pliki CSV przed importem” oraz prosty przykład danych i błędu. Nie wciskaj całej sesji terminala do miniatury. Odsuń ważny tekst od krawędzi na wypadek przycięcia obrazu przez platformę.

Prześlij obraz i sprawdź udostępniony link

Otwórz Settings repozytorium, znajdź Social preview, wybierz Edit i prześlij obraz. Udostępnij adres publicznego repozytorium tam, gdzie zobaczą go odbiorcy. Sprawdź efekt właśnie w tym miejscu: pomyślne przesłanie nie oznacza, że każda platforma natychmiast wymieni podgląd zapisany w pamięci podręcznej.

  • Potwierdź, że obraz dotyczy udostępnianego repozytorium.
  • Przed przesłaniem sprawdź format, wymiary w pikselach i rozmiar pliku.
  • Zadbaj o kontrast; przezroczystą grafikę sprawdź na jasnym i ciemnym tle.
  • Jeśli obraz jest nieaktualny, potwierdź zapisane ustawienie repozytorium i sprawdź pamięć podręczną platformy docelowej.

Zachowaj zgodność obrazu z projektem

Używaj tej samej nazwy i opisu celu w obrazie, README oraz ogłoszeniu wydania. Jeśli zrzut pokazuje funkcję eksperymentalną, oznacz ją lub pokaż stabilny sposób użycia. Nie dodawaj zmyślonych liczników gwiazdek, logotypów klientów ani obietnic wydajności.

Wróć do obrazu, gdy zmieni się główny przypadek użycia projektu. Podgląd jest materiałem komunikacyjnym, a nie gwarancją pozycji w wyszukiwarce, współczynnika kliknięć czy gwiazdek GitHub.

Częste pytania

Czy to ten sam obraz co awatar właściciela repozytorium?

Nie. Awatar identyfikuje konto. Własny podgląd społecznościowy reprezentuje konkretny projekt podczas udostępniania jego linku.

Czy podgląd może mieć przezroczyste tło?

GitHub obsługuje przezroczystość PNG. Sprawdź kontrast na różnych tłach; jednolite tło jest praktycznym wyborem, gdy wygląd miejsca docelowego jest nieznany.

Dlaczego po przesłaniu nadal widzę stary podgląd?

Najpierw sprawdź, czy nowy obraz zapisano we właściwym repozytorium. Platformy mogą buforować podglądy; sposób ich odświeżania jest niezależny od ustawienia repozytorium.

Źródła