Guia de README do GitHub

GitHub Profile 3D Contrib: configure um calendario 3D no README

github-profile-3d-contrib e ideal para mostrar um calendario 3D atualizado no README do perfil. Este guia cobre permissoes, pastas de saida, insercao no README, imagens vazias e quando GitHub City e melhor.

Resposta rapida: o que e GitHub Profile 3D Contrib?

GitHub Profile 3D Contrib é uma GitHub Action que transforma o calendário de contribuições em imagens 3D prontas para o perfil. O workflow gera os arquivos e faz commit deles para que o README mostre um calendário 3D atualizado.

A intenção é diferente da do GitHub City. Quem busca github profile 3d contrib normalmente precisa de um arquivo YAML, um caminho de imagem no README e uma agenda de atualização confiável; quem busca GitHub City costuma querer um visualizador online sem editar repositórios.

Use o profile-3d-contrib quando a saída deve ficar no README. Use o GitHub City para explorar no navegador e a comparação de ferramentas 3D para escolher entre imagens, cidades interativas e modelos.

Para github profile 3d contrib, esta pagina cobre automacao de README, GitHub Actions, arquivos gerados e solucao de problemas. Para digitar um usuario e ver uma cidade online, use GitHub City.

Diagrama que compara o calendário 3D do README, o GitHub City e as saídas do GitHub Skyline
profile-3d-contrib automatiza o README; GitHub City é um visualizador interativo; Skyline é melhor para saídas em formato de modelo.

Como configurar profile-3d-contrib sem quebrar o README

Comece com a action oficial e verifique cada requisito do GitHub. Uma configuracao pequena, explicita e facil de executar manualmente e mais segura.

1

Crie o repositorio especial de perfil

Crie um repositorio publico com o mesmo nome exato do seu usuario do GitHub.

2

Adicione o workflow

Crie .github/workflows/profile-3d.yml, conceda contents: write e use a action com GITHUB_TOKEN.

3

Execute manualmente uma vez

Use workflow_dispatch na primeira execucao para ver erros de permissao, token ou YAML.

4

Incorpore a imagem gerada

Adicione o caminho SVG ou PNG ao README.md e confira branch, pasta, maiusculas e caminho relativo.

5

Revise contribuicoes privadas

Contribuicoes privadas so aparecem como resumo publico se seu perfil permitir.

Arquivos e ajustes para verificar

A configuração do profile-3d-contrib é pequena, mas tem várias partes conectadas. Trate o workflow, a pasta de imagens, o caminho do README e as configurações do perfil como uma única cadeia.

Se a imagem é atualizada no log do Actions, mas não no README, o problema geralmente não é o gerador. Com mais frequência, está no caminho commitado, na branch, no cache ou na referência Markdown.

Arquivo ou ajuste Finalidade O que verificar
README.md Mostra o calendario 3D no perfil. O caminho deve bater exatamente com o arquivo commitado.
.github/workflows/profile-3d.yml Executa o gerador por agenda ou manualmente. Inclua permissao de escrita e gatilho manual.
Pasta de saida Armazena os SVG/PNG gerados. Confirme que os arquivos foram commitados.
Ajustes do perfil Controlam resumo publico de atividade privada. Ative apenas se quiser essa exibicao.
Etapa de commit do workflow Grava arquivos SVG ou PNG gerados no repositorio do perfil. Inclua apenas imagens geradas, evite commits vazios e ignore arquivos de cache.

profile-3d-contrib vs GitHub City vs GitHub Skyline

Todas essas ferramentas usam dados de contribuições do GitHub, mas resolvem tarefas diferentes. Não escolha apenas pela expressão gráfico de contribuições 3D.

profile-3d-contrib

Ideal para uma imagem sempre visivel no README. Requer repositorio e Actions.

GitHub City

Ideal para exploracao instantanea em uma cidade 3D no navegador, sem YAML.

GitHub Skyline

Melhor para uma forma 3D ou saida exportavel, nao para README.

Corrigir imagens 3D ausentes ou antigas

Se a imagem gerada está ausente, abra primeiro a execução mais recente do Actions. Uma falha aponta para problemas de token, permissão, YAML ou limite de requisições. Uma execução bem-sucedida sem imagem no README aponta para o caminho de saída ou para o Markdown.

Se a imagem parece vazia, compare-a com o gráfico oficial de contribuições do GitHub. O que não aparece no calendário oficial normalmente também não aparece na imagem 3D. Para problemas de commits, use a checklist do commit graph.

Se a imagem estiver desatualizada, verifique o fuso horário do trigger agendado, a proteção da branch, se a etapa de commit realmente enviou os arquivos e se o GitHub está usando cache da imagem do README.

Se Actions concluir com sucesso mas a imagem parecer antiga, confira o hash do arquivo, o caminho no README e possiveis caches do GitHub ou do navegador.

Antes de trocar de action, registre o que mudou entre duas execucoes: horario do workflow, branch usada, pasta de saida, nome do arquivo e caminho no README. Esse historico simples evita confundir problema de permissao com cache de imagem ou referencia Markdown antiga.

Se você ainda está planejando todo o perfil, use o guia de modelo de GitHub profile README antes de adicionar uma imagem 3D. Para widgets estáticos de README que não são imagens 3D geradas, use o guia de GitHub streak stats em vez de alterar este workflow do Actions.

Não depure dados Git brutos com um gerador de README

profile-3d-contrib visualiza o que o GitHub expõe. Quando as contagens parecem erradas, verifique e-mails, branches padrão, configurações de contribuições privadas e regras de forks antes de mudar o gerador 3D.

FAQ

profile-3d-contrib e igual ao GitHub City?

Nao. profile-3d-contrib gera imagens via Actions; GitHub City e interativo no navegador.

Preciso de GitHub Actions?

Sim. O setup normal usa Actions para regenerar e commitar a imagem.

Por que a imagem 3D esta vazia?

Confira o grafico oficial, permissoes, token, usuario, branch de saida e caminho no README.

Contribuicoes privadas podem aparecer?

Apenas o resumo publico permitido pelo GitHub pode ser refletido.

Qual ferramenta para compartilhar rapido?

GitHub City para vista interativa; profile-3d-contrib para README.

Quais arquivos github-profile-3d-contrib costuma gerar?

Normalmente gera imagens SVG ou PNG do calendario 3D, salvas no repositorio do perfil e referenciadas no README.md.

O que verificar antes de alterar o YAML?

Nome do repositorio do perfil, permissoes do Actions, pasta de saida, branch, caminho no README, usuario e atividade visivel no GitHub.

Fontes e leituras uteis