Un repositorio público puede ser difícil de evaluar si se abre en carpetas inexplicables o en un comando de configuración desactualizado. Un README conciso reduce esa fricción y permite que el revisor se concentre en el código y las decisiones.
Incluye lo esencial
- Indique qué hace el proyecto y para quién es.
- Enumere los requisitos previos y los pasos de configuración probados en el orden en que debe ejecutarlos un nuevo colaborador.
- Describa las funciones clave, las limitaciones conocidas y cómo ejecutar pruebas o ver una demostración.
Verifique las instrucciones desde un comienzo limpio
Siga sus propios pasos de configuración en un directorio temporal o de pago nuevo. Reemplace las rutas específicas de la máquina, elimine las claves privadas y los datos personales, y asegúrese de que los comandos coincidan con los scripts actuales del repositorio.
Agregue una captura de pantalla o una nota de arquitectura solo cuando aclare la experiencia. Un proyecto pequeño con instrucciones precisas es más útil que un README grande lleno de afirmaciones que el código no admite.