Guia para README de GitHub

GitHub Profile 3D Contrib: configura un calendario 3D en tu README

github-profile-3d-contrib sirve para mostrar un calendario 3D actualizado dentro del README del perfil. Esta guia cubre permisos, rutas de salida, insercion en README, imagenes vacias y cuando conviene GitHub City.

Respuesta rapida: que es GitHub Profile 3D Contrib?

GitHub Profile 3D Contrib es una GitHub Action que convierte el calendario de contribuciones en imagenes 3D listas para un perfil. El workflow genera archivos y los confirma para que el README muestre un calendario 3D actualizado.

La intencion es distinta de GitHub City. Quien busca github profile 3d contrib normalmente necesita un archivo YAML, una ruta de imagen y una programacion fiable; quien busca GitHub City suele querer un visualizador online sin editar repositorios.

Usa profile-3d-contrib si la salida debe vivir en el README. Usa GitHub City para explorar en el navegador y la comparacion de herramientas 3D para elegir entre imagenes, ciudades interactivas y modelos.

Si llegaste buscando github profile 3d contrib, el limite es claro: esta pagina trata automatizacion de README, GitHub Actions, archivos generados y errores. Para escribir un usuario y ver una ciudad online, usa GitHub City.

Diagrama que compara calendario 3D para README, GitHub City y GitHub Skyline
profile-3d-contrib automatiza el README; GitHub City explora en navegador; Skyline se orienta a modelos.

Como configurar profile-3d-contrib sin romper el README

Empieza con la accion oficial y verifica cada requisito antes de esperar que la imagen aparezca en el perfil. La configuracion mas segura es pequena, explicita y facil de ejecutar manualmente.

1

Crea el repositorio especial de perfil

Crea un repositorio publico cuyo nombre coincida exactamente con tu usuario de GitHub. Ese repositorio alimenta el README de perfil.

2

Agrega el archivo workflow

Crea .github/workflows/profile-3d.yml, concede contents: write y usa la action profile-3d-contrib con GITHUB_TOKEN y tu usuario.

3

Ejecutalo manualmente una vez

Usa workflow_dispatch en la primera ejecucion para ver errores de permisos, token, YAML o archivos faltantes sin esperar al cron diario.

4

Inserta la imagen generada

Agrega la ruta SVG o PNG generada al README.md. Si la imagen se rompe, revisa rama, carpeta, mayusculas y ruta relativa.

5

Revisa las contribuciones privadas

Las contribuciones privadas solo pueden resumirse publicamente si tu perfil lo permite. La imagen no puede mostrar actividad que GitHub no expone.

Archivos y ajustes que debes revisar

La configuracion es pequena, pero depende de una cadena: workflow, carpeta generada, ruta del README y ajustes de perfil.

Si Actions genera archivos pero el README no cambia, el problema suele estar en la ruta, la rama, la cache o la referencia Markdown.

Archivo o ajuste Proposito Que revisar
README.md Muestra el calendario 3D en tu perfil de GitHub. La ruta debe coincidir exactamente con el archivo confirmado, incluidas mayusculas.
.github/workflows/profile-3d.yml Ejecuta el generador por horario o disparo manual. Incluye permisos de escritura y un disparador manual para depurar.
Carpeta de salida Guarda los SVG o PNG generados. Confirma que los archivos se commitean al terminar el workflow.
Ajustes del perfil Controlan si la actividad privada se resume publicamente. Activalo solo si quieres que esa senal aparezca.
Paso de commit del workflow Escribe los SVG o PNG generados en el repositorio del perfil. Haz commit solo de imagenes generadas, evita commits vacios y no incluyas archivos de cache.

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

Todos usan datos de contribuciones, pero resuelven trabajos distintos. No elijas solo por la frase grafico 3D.

profile-3d-contrib

Ideal para una imagen siempre visible en el README de perfil. Requiere repositorio y Actions, pero el visitante ve el resultado sin abrir otro sitio.

GitHub City

Ideal para exploracion instantanea. Escribe un usuario en el navegador y revisa una ciudad 3D sin agregar YAML al repositorio.

GitHub Skyline

Mejor si buscas una forma 3D o salida orientada a modelo, no una imagen de README ni una ciudad interactiva.

Solucionar imagenes 3D ausentes o desactualizadas

Abre primero la ultima ejecucion de Actions. Si fallo, mira permisos, token, YAML o limites. Si paso pero no hay imagen en README, revisa ruta y Markdown.

Si la imagen sale vacia, comparala con el grafico oficial de GitHub. Lo que no aparece ahi normalmente no aparecera en la imagen 3D. Para commits, usa la lista de comprobacion de commits.

Si esta obsoleta, revisa zona horaria del cron, proteccion de rama, push del commit y cache del README.

Si Actions termina bien pero la imagen no cambia, revisa el hash del archivo generado y la URL usada en README. La cache de GitHub o del navegador puede hacer que una ejecucion correcta parezca antigua.

Si todavía estás planificando todo el perfil, usa la guía de plantilla de GitHub profile README antes de añadir una imagen 3D. Para widgets estáticos de README que no son imágenes 3D generadas, usa la guía de GitHub streak stats en lugar de cambiar este workflow de Actions.

No depures Git bruto desde un generador de README

profile-3d-contrib visualiza lo que GitHub expone. Corrige emails, ramas, privacidad y reglas de forks antes de cambiar el generador.

FAQ

Es profile-3d-contrib lo mismo que GitHub City?

No. profile-3d-contrib genera imagenes para un README mediante GitHub Actions. GitHub City es un visualizador interactivo en navegador.

Necesito GitHub Actions para usar profile-3d-contrib?

Si. La configuracion normal usa Actions para regenerar y confirmar la imagen automaticamente.

Por que mi imagen 3D esta en blanco?

Comprueba si el grafico oficial tambien esta vacio y luego revisa permisos, token, usuario, rama de salida y ruta del README.

Pueden aparecer contribuciones privadas?

Solo puede reflejarse el resumen publico que GitHub permite mostrar. Activa la visibilidad de contribuciones privadas si quieres esa senal.

Que herramienta uso para compartir una vista rapida?

Usa GitHub City para una vista interactiva rapida. Usa profile-3d-contrib cuando la salida debe vivir en el README.

Que archivos suele generar github-profile-3d-contrib?

Normalmente genera imagenes SVG o PNG del calendario 3D, las guarda en una carpeta del repositorio del perfil y README.md las referencia.

Que revisar antes de cambiar el YAML?

Comprueba el nombre del repositorio de perfil, permisos de Actions, carpeta de salida, rama, ruta en README, usuario y si GitHub muestra la actividad esperada.

Fuentes y lectura adicional