Crea un README impecable con GitHub Copilot

Abre o crea tu archivo README

El primer paso es abrir el archivo especial README.md dentro de tu proyecto. Si todavía no existe, tendrás que crearlo. La parte .md significa que es un archivo Markdown, una forma sencilla de dar formato al texto (crear títulos, listas o poner palabras en negrita) que GitHub entiende.

Para hacerlo, mira el panel Explorador en el lado izquierdo de tu ventana de VS Code: ahí verás todos los archivos y carpetas de tu proyecto. Si no lo ves, pulsa Ctrl + Shift + E (en Windows/Linux) o Cmd + Shift + E (en Mac) para mostrarlo.

Acción: En el panel Explorador, haz clic derecho sobre la carpeta principal de tu proyecto y elige "New File". Escribe README.md exactamente como se muestra y pulsa Enter. Qué verás: Aparecerá un campo para escribir el nombre del archivo en el panel Explorador. Qué ocurrirá después: El nuevo archivo README.md se abrirá como un documento en blanco en el área principal del editor de VS Code. Si se ve diferente: Si ya tienes un archivo README.md, simplemente haz clic sobre él en el panel Explorador para abrirlo y, si quieres empezar de cero, borra el texto que tenga.

Sabrás que funcionó cuando aparezca un archivo en blanco llamado README.md en el área principal del editor de VS Code, listo para que escribas en él.

Empieza la descripción de tu proyecto

Ahora que tu archivo README.md está abierto, le vamos a pedir a Copilot que ayude a escribir la descripción principal. GitHub Copilot usa lo que se llama "autocompletado", parecido al texto predictivo de tu móvil, pero mucho más inteligente. Usa inteligencia artificial (IA) para adivinar lo que quieres escribir a continuación según el contexto.

Acción: Coloca el cursor parpadeante en la primera línea de tu archivo README.md, escribe un título breve para tu proyecto y pulsa la tecla Enter. Qué verás: Después de escribir el título, normalmente aparecerá una sugerencia de Copilot en gris justo después del cursor. Qué ocurrirá después: Copilot leerá tu título corto y empezará automáticamente a sugerir un párrafo completo describiendo tu proyecto. Si la sugerencia te parece buena, pulsa la tecla Tab para aceptarla. Si quieres ver otra opción, pulsa Ctrl + Space (en Windows/Linux) u Option + Space (en Mac) para ir pasando entre sugerencias hasta encontrar la que te guste. Si se ve diferente: Si Copilot no ofrece una sugerencia enseguida, asegúrate de que la extensión de GitHub Copilot esté activada (comprueba en la esquina inferior derecha de VS Code si hay un pequeño icono de Copilot). También puedes escribir algunas palabras más por tu cuenta antes de volver a pulsar Enter.

Sabrás que funcionó cuando Copilot muestre una sugerencia de texto en gris directamente en el editor y hayas aceptado la descripción pulsando Tab.

Genera una guía de instalación

La mayoría de proyectos necesitan instrucciones para configurarlos. Copilot también puede generar estas secciones comunes. A menudo detecta con bastante acierto en qué lenguaje de programación está tu proyecto mirando otros archivos del repositorio y sugiere los comandos adecuados.

Acción: Mueve el cursor unas líneas hacia abajo (pulsa Enter varias veces para hacer espacio), escribe ## Installation, pulsa Enter, luego escribe un pequeño indicio como Run the following command: y vuelve a pulsar Enter. Qué verás: Tu nuevo título, seguido de tu indicio y después una sugerencia en gris con un comando de instalación. Qué ocurrirá después: Normalmente Copilot completará automáticamente un comando de terminal (un comando que escribirías en la terminal del ordenador), como npm install (para proyectos en JavaScript) o pip install -r requirements.txt (para proyectos en Python). Si se ve diferente: Si el comando sugerido no coincide con el lenguaje o el gestor de paquetes (la herramienta que se encarga de los componentes del software) de tu proyecto, simplemente bórralo y escribe un indicio más específico. Por ejemplo, Install Python dependencies: si te sugirió npm install para un proyecto en Python.

Sabrás que funcionó cuando Copilot sugiera un comando para instalar dependencias y lo hayas aceptado pulsando Tab.

Añade un ejemplo de uso

Una vez que el proyecto está instalado, ¡la gente necesita saber cómo usarlo! Podemos seguir un patrón parecido para que Copilot genere un comando que inicie tu aplicación.

Acción: Después de la sección de instalación, mueve el cursor unas líneas hacia abajo, escribe ## Usage, pulsa Enter, luego escribe un breve indicio como Start the app with: y pulsa Enter. Qué verás: Tu nuevo título e indicio, seguidos del comando sugerido por Copilot. Qué ocurrirá después: Copilot propondrá un comando como npm start o python app.py, otra vez según lo que deduzca de tu proyecto. Acepta el que sea correcto pulsando Tab. Si se ve diferente: Si el comando sugerido no es del todo preciso, puedes acceptarlo y luego editar la línea manualmente para que sea exacto en tu proyecto. También puedes añadir una pequeña descripción en lenguaje claro debajo del comando para aclarar qué hace, por ejemplo: "This launches the local server on http://localhost:5000".

Sabrás que funcionó cuando Copilot ofrezca un comando para poner en marcha tu proyecto y lo hayas aceptado.

Incluye una descripción general del proyecto

Un buen README suele terminar con un breve resumen de lo que el proyecto quiere conseguir o qué tecnologías clave utiliza. Vamos a pedirle a Copilot que nos dé una descripción rápida.

Acción: Mueve el cursor unas líneas hacia abajo desde la sección de uso, escribe ## Overview, pulsa Enter, luego escribe algunas palabras descriptivas como This project demonstrates... y pulsa Enter. Qué verás: Tu nuevo título ## Overview, seguido de tu indicio y después una sugerencia de resumen más detallada de Copilot. Qué ocurrirá después: Copilot completará un párrafo conciso que resume el propósito y los puntos destacados de tu proyecto. Si se ve diferente: Si el resumen es demasiado genérico, puedes añadir palabras clave más concretas a tu indicio inicial (por ejemplo, This project demonstrates data fetching and UI components...) para guiarlo hacia una respuesta más ajustada.

Sabrás que funcionó cuando Copilot te dé un párrafo corto y descriptivo resumiendo tu proyecto, y puedas aceptarlo.

Termina con una nota sobre la licencia

Es una buena práctica indicar la licencia de tu proyecto. Esto le dice a los demás cómo pueden usar, modificar y distribuir tu código. La Licencia MIT es una opción muy habitual y permisiva para proyectos de código abierto.

Acción: Debajo de la sección Overview, añade un nuevo título escribiendo ## License y pulsa Enter. En la siguiente línea, escribe This project is licensed under the MIT License. Qué verás: El nuevo título y la declaración de la licencia aparecerán en tu archivo README.md. Qué ocurrirá después: Ya has completado las secciones esenciales de tu archivo README. Copilot normalmente no genera automáticamente el texto exacto de una licencia a menos que se lo pidas mucho, así que es buena idea añadir una habitual manualmente. Si se ve diferente: Si necesitas una licencia distinta, busca en internet textos de licencias comunes (por ejemplo, "Apache 2.0 License text") y copia la declaración correspondiente en esta sección.

Sabrás que funcionó cuando la sección ## License esté visible y completa en tu archivo README.md.