Guias de projetos

Imagem de prévia social do GitHub: tamanho, configuração e lista de verificação

A prévia social de um repositório é a imagem que pode aparecer quando seu link é compartilhado. Use-a para explicar o projeto rapidamente: um nome curto, uma proposta útil e um exemplo reconhecível. Ela complementa o README em vez de substituí-lo.

Equipe editorial do GitHubStart · Atualizado

Prepare o arquivo certo

As orientações atuais do GitHub aceitam arquivos PNG, JPG ou GIF menores que 1 MB. Recomendam pelo menos 640 × 320 pixels, com 1280 × 640 para a melhor exibição. Comece com a tela maior na proporção 2:1 e depois verifique a legibilidade em um tamanho bem menor.

Para um validador fictício de CSV, uma composição clara poderia mostrar o nome do projeto, “Verifique arquivos CSV antes de importar” e um exemplo simples de entrada e erro. Evite espremer uma sessão inteira de terminal em uma miniatura. Mantenha textos importantes longe das bordas, caso a plataforma de compartilhamento recorte a imagem.

Envie e confira o link compartilhado

Abra Settings do repositório, localize Social preview, escolha Edit e envie a imagem. Compartilhe a URL pública do repositório no destino onde seu público a verá. Confira o resultado ali; um envio bem-sucedido não garante que todas as plataformas substituam imediatamente uma prévia em cache.

  • Confirme que a imagem pertence ao repositório que você está compartilhando.
  • Confira formato, dimensões em pixels e tamanho do arquivo antes do envio.
  • Use contraste legível; examine imagens transparentes sobre fundos claros e escuros.
  • Se a imagem estiver desatualizada, confirme a configuração salva no repositório e investigue o cache da plataforma de destino.

Mantenha a prévia coerente com o projeto

Use o mesmo nome e finalidade do projeto na imagem, no README e no anúncio da versão. Se uma captura mostrar uma funcionalidade experimental, identifique-a ou use um fluxo estável. Não adicione contagens de Stars, logotipos de clientes ou alegações de desempenho inventados.

Revise a imagem quando o caso de uso central do projeto mudar. Uma prévia é um recurso de comunicação, não uma garantia independente de posicionamento, taxa de cliques ou Stars no GitHub.

Perguntas frequentes

É o mesmo que o avatar do proprietário do repositório?

Não. O avatar do proprietário identifica a conta. Uma prévia social personalizada do repositório representa um projeto específico quando seu link é compartilhado.

A prévia pode usar um fundo transparente?

O GitHub aceita transparência em PNG. Confira o contraste sobre diferentes fundos; um fundo sólido é uma opção prática quando a aparência do destino é incerta.

Por que ainda vejo a prévia antiga depois do envio?

Primeiro verifique se a nova imagem foi salva no repositório correto. Plataformas de compartilhamento podem manter prévias em cache; a atualização delas é independente da configuração do repositório.

Referências