top of page

La importancia de un buen README.md en un repositorio.

Actualizado: 4 oct 2022

Finalmente el verano muestra los dientes en forma de radiación ultravioleta nivel 1000 en Nueva Zelanda. En un rincón con sombra del patio, me traje la laptop y un café para sufrir más el calor y escribirles el primer post del año! Y esta vez voy a arrancar con un post de crecimiento profesional, mitad información útil para programar y mitad información útil para tener mejor visibilidad a la hora de postularnos a trabajos. Qué tal?


Una biblioteca con forma de READ
Readme...que nunca te falte!

Alguna vez les pasó que encuentran una posible solución a un problema en forma de librería y, cuando van a consultar el repositorio para aprender de qué va la cosa... el README no dice nada útil? A mi si, muchas veces.


También ha pasado que al entrar a trabajar en un proyecto, te dan el repositorio usado para automatizar y... otra vez nada en el README. Pareciera una tendencia bastante común en el ámbito del desarrollo y, me atrevería a decir, sobre todo en Automation.


Pareciera que un desarrollador puede pasar 1 hora ajustando nombres de variables, indentation y otras yerbas pero no 10 minutos haciendo un README.md prolijo e informativo.


Primero que nada: Qué es un README.md?


Un README es, como podrán adivinar, un archivo que hay que leer antes de empezar a toquetear código. Se acuerdan antes (y en la actualidad también), que los programas, videojuegos y software en general venía con un archivo de texto llamado ReadMe o ReadMe First?


Apuesto a que era lo primero que leían antes de siquiera ejecutar el juego o programa. Este ReadMe del que hablo hoy es lo mismo! Es la puerta de entrada a un repositorio. Está en la raíz del repositorio y, ese .md que ven como extensión se refiere a MarkDown, un lenguaje útil, flexible y práctico que nos va a permitir añadir links, listas, links a ar