Aprende Inglés, Programación, AI y Ciberseguridad.

Antes:$249

Currency
$209
Suscríbete

Termina en:

05d

00h

50m

50s

84

Aprende cómo tener el mejor README en tu perfil de GitHub

52118Puntos

hace 2 años

El perfil de GitHub es tu carta de presentación en esta red social enfocada en el desarrollo de software. Si no estás haciendo uso de la opción de README, no le estás sacando todo el provecho que deberías a esta funcionalidad.

En este blog te voy a explicar, paso a paso, como configurar tu README y sacarle el máximo provecho, ¡empecemos!

1. Crea el repositorio de tu README

Lo primero que debes hacer es crear el repositorio que contendrá el README de tu perfil, para lograrlo sigue estos 4 pasos:

  1. Inicia sesión en GitHub y crea un nuevo repositorio.

  2. El nombre de este repositorio deberá ser el mismo que tu nombre de usuario.

    Si te sale un mensaje como este, lo estás haciendo bien 👍🏻

    Nombre del repositorio
  3. Asegúrate de que el repositorio sea público, y que además, incluya un archivo README.md.

    Privacidad del repositorio
  4. Por último, da clic en create repository, ¡y listo! Ya tienes el repositorio con el archivo README listo para editar.

2. Manos a la obra con el README

El README que ya generaste debe estar escrito con formato markdown. Para esto*,* GitHub tiene su propia documentación sobre este lenguaje, así que te recomiendo que le eches un ojo si todavía no lo has usado.

Ahora que ya tienes tu README, y que además dominas markdown, es momento de empezar a poner la información que quieras compartir en este archivo: siéntete libre de incluir la información que consideres más pertinente.

A continuación te dejaré los puntos claves que me han funcionado en mi perfil:

Saluda a todo aquel que visite tu perfil

Nada mejor que comenzar una presentación con un saludo.

Incluye un encabezado

Puede ser una imagen, un gif o incluso el logo de tu marca personal.

Marca personal

Usa este espacio para enlazar tus perfiles

Prueba añadiendo tu perfil de LinkedIn, Twitter o cualquier red social que consideres importante mencionar.

encuentrame

Escribe acerca de ti

Habla sobre tus habilidades y sobre lo que te apasiona. Incluso puedes utilizar un resumen similar al que pondrías en tu LinkedIn.

Acerca de

Lista tus proyectos

Los más recientes, los más valiosos o de los que te sientas más orgullosa u orgulloso de compartir al mundo. No te olvides de incluir una breve descripción del proyecto y el enlace, ya sea al repositorio o a un live preview.

proyectos

Menciona las tecnologías principales que manejas

Busca enfocarlas en los proyectos que has hecho y en las vacantes que estás interesada o interesado.

tecnologias

💡 Si quieres que se vean como las de mi perfil, puedes usar Badges 4 Readme de Alexandre Sanlim, hay una amplia variedad de temas e incluso los puedes personalizar.

Añade tus estadísticas de uso o los lenguajes que más usas

Incluso ambos: para eso puedes utilizar GitHub Readme Stats de Anurag Hazra.

Estadísticas

3. Afinando un poco más el perfil

En este punto ya creaste el README de tu perfil e incluiste toda la información necesaria para hacerlo brillar. Pero, ¿recuerdas que te dije que tu perfil es tu carta presentación?

Bueno, el README no es la única parte del perfil de GitHub, pues también tenemos la barra lateral con tu foto, nombre e información adicional, ¡así que sácale provecho!

Incluye tu foto

Quien llegue a tu perfil seguramente quiere conocerte.

alexcamacgogz

Agrega una breve descripción

Habla sobre tus habilidades y sobre los lenguajes que domines.

Habilidades

Agrega información adicional

Como el lugar donde trabajas, tu correo, tu página personal, entre otros datos que consideres relevantes.

Información adicional

Ahora es tu turno

Sigue todas las recomendaciones que te compartí en este blog y aprovecha este espacio para expresarte y contar quien eres, qué estás haciendo, dónde te pueden encontrar y cuáles son tus proyectos: ¡no te limites, sé tu misma o tú mismo!

No olvides compartirme en los comentarios cómo quedó tu perfil de GitHub mejorado con todos estos tips. Yo estaré encantada de echarles un ojo y seguramente el resto de la comunidad también.

Y como siempre te quiero recomendar un curso, esta vez te dejo uno de mis favoritos: el Curso Profesional de Git y GitHub, ya que con este no habrá repositorio ni control de versiones que se te resista. Dale un vistazo y anímate a aprender Git como muy pocos lo hacen.

Recuerda, nunca pares de aprender 💚

Alex
Alex
alexcamachogz

52118Puntos

hace 2 años

Todas sus entradas
Escribe tu comentario
+ 2
Ordenar por:
1
4953Puntos

gracias por compartir esa info, fue de gran utilidad.

1
10989Puntos

Muchas gracias por este post!

Aquí dejo mi README mejorado

1
3592Puntos

No había pensado en una buena intro para tu perfil de git hasta que vi este post 😍.

Muchas gracias Alex, ¡estoy en proceso de aprendizaje para postular con ustedes! 🚀.

Mientras tanto les comparto como quedó mi repo de git

1
52269Puntos

Me sirvió muchisimo el blog, ahora tengo mi github mucho más organizado y presentable. 💚

1
1925Puntos

Muchisimas gracias por compartir, no sabia que se podria hacer esto.

1
28350Puntos

Ya había hecho mi Readme y por curiosidad entre, y ahora pense en listar los proyectos mas importantes.
Lo importante de nunca parar de aprender.