Crea un README pulido con GitHub Copilot

Abre o crea tu archivo README

Tu primer paso es abrir el archivo especial README.md dentro de tu proyecto. Si aún no existe, deberás crearlo. Esta parte .md significa que es un archivo Markdown, que es una forma sencilla de formatear texto (como crear encabezados, listas o poner palabras en negrita) que GitHub entiende.

Para hacerlo, mira el panel del Explorador en el lado izquierdo de tu ventana de VS Code – muestra todos los archivos y carpetas de tu proyecto. Si no lo ves, presiona Ctrl + Shift + E (en Windows/Linux) o Cmd + Shift + E (en Mac) para revelarlo.

Acción: En el panel del Explorador, haz clic derecho en la carpeta principal de tu proyecto, luego elige "New File" (Nuevo archivo). Escribe README.md exactamente como se muestra y presiona Enter. Lo que ves: Aparece un nuevo campo de entrada para el nombre del archivo en el panel del Explorador. Lo que ocurre 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 en él en el panel del Explorador para abrirlo, luego borra cualquier texto existente si quieres empezar de nuevo para esta guía.

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

Inicia la descripción de tu proyecto

Ahora que tu archivo README.md está abierto, le pediremos a Copilot que nos ayude a escribir la descripción principal. GitHub Copilot utiliza lo que se llama "autocompletado", que es como el texto predictivo de tu teléfono, pero mucho más inteligente. Utiliza inteligencia artificial (IA) para adivinar lo que quieres escribir a continuación basándose en tu contexto.

Acción: Coloca el cursor parpadeante en la primera línea de tu archivo README.md, escribe un encabezado breve para tu proyecto y luego presiona la tecla Enter. Lo que ves: Después de escribir el encabezado, una sugerencia atenuada de Copilot suele aparecer justo después de tu cursor. Lo que ocurre después: Copilot leerá tu breve encabezado y automáticamente comenzará a sugerir un párrafo completo que describe tu proyecto. Si la sugerencia te parece bien, presiona la tecla Tab para aceptarla. Si quieres otra opción, presiona Ctrl + Espacio (en Windows/Linux) u Opción + Espacio (en Mac) para alternar entre diferentes sugerencias hasta que encuentres una que te guste. Si se ve diferente: Si Copilot no ofrece una sugerencia de inmediato, asegúrate de que la extensión de GitHub Copilot esté habilitada (revisa la esquina inferior derecha de VS Code para ver un pequeño ícono de Copilot). También puedes intentar escribir algunas palabras más por tu cuenta antes de presionar Enter nuevamente.

Sabrás que funcionó cuando Copilot presente una sugerencia de texto atenuada directamente en tu editor y hayas aceptado una descripción presionando Tab.

Genera una guía de instalación

La mayoría de los proyectos necesitan instrucciones sobre cómo configurarlos. Copilot también puede ayudar a generar estas secciones comunes. A menudo, adivina de forma inteligente qué lenguaje de programación utiliza tu proyecto a partir de otros archivos en tu repositorio y sugiere comandos relevantes.

Acción: Mueve el cursor unas líneas hacia abajo (presiona Enter varias veces para crear algo de espacio), escribe ## Instalación, presiona Enter, luego escribe una indicación corta como Ejecuta el siguiente comando: y presiona Enter. Lo que ves: Tu nuevo encabezado, seguido de tu indicación, y luego una sugerencia atenuada para un comando de instalación. Lo que ocurre después: Copilot normalmente autocompletará un comando de shell (un comando que escribirías en la terminal de una computadora) como npm install (para proyectos JavaScript) o pip install -r requirements.txt (para proyectos Python). Si se ve diferente: Si el comando sugerido no coincide con el lenguaje o el gestor de paquetes de tu proyecto (la herramienta que maneja los componentes del software), simplemente bórralo y escribe una indicación más específica. Por ejemplo, Instala las dependencias de Python: si sugirió npm install para tu proyecto Python.

Sabrás que funcionó cuando Copilot sugiera una línea de comando para instalar dependencias, y la hayas aceptado presionando Tab.

Añade un ejemplo de uso

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

Acción: Después de la sección de instalación, mueve el cursor unas líneas hacia abajo, escribe ## Uso, presiona Enter, luego escribe una indicación breve como Inicia la aplicación con: y presiona Enter. Lo que ves: Tu nuevo encabezado y la indicación, seguidos del comando sugerido por Copilot. Lo que ocurre después: Copilot propondrá un comando como npm start o python app.py, de nuevo, basándose en lo que deduce de tu proyecto. Acepta el apropiado presionando Tab. Si se ve diferente: Si el comando sugerido es ligeramente incorrecto, puedes aceptarlo y luego editar manualmente la línea para que sea precisa para tu proyecto. También podrías añadir una descripción corta y sencilla debajo del comando para aclarar lo que hace, por ejemplo: "Esto inicia el servidor local en http://localhost:5000".

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

Incluye una descripción general del proyecto

Un buen README a menudo concluye con un breve resumen de lo que el proyecto pretende lograr o qué tecnologías clave utiliza. Pidámosle a Copilot que proporcione un resumen rápido.

Acción: Mueve el cursor unas líneas hacia abajo desde la sección de uso, escribe ## Visión General, presiona Enter, luego escribe unas pocas palabras descriptivas como Este proyecto demuestra... y presiona Enter. Lo que ves: Tu nuevo encabezado ## Visión General, seguido de tu indicación, y luego una sugerencia de resumen más detallada de Copilot. Lo que ocurre después: Copilot completará un párrafo conciso que resume el propósito y los aspectos más destacados de tu proyecto. Si se ve diferente: Si el resumen es demasiado general, puedes añadir palabras clave más específicas a tu indicación inicial (por ejemplo, Este proyecto demuestra la obtención de datos y componentes de UI...) para guiar a Copilot hacia una respuesta más personalizada.

Sabrás que funcionó cuando Copilot te dé un párrafo corto y descriptivo que resuma tu proyecto, que luego podrás aceptar.

Finaliza con una nota de licencia

Es una buena práctica especificar la licencia de tu proyecto. Esto les dice a otros cómo pueden usar, modificar y distribuir tu código. La Licencia MIT es una opción muy común y permisiva para proyectos de código abierto.

Acción: Debajo de tu sección de Visión General, añade un nuevo encabezado escribiendo ## Licencia, luego presiona Enter. En la siguiente línea, escribe Este proyecto está licenciado bajo la Licencia MIT. Lo que ves: El nuevo encabezado y la declaración de licencia apareciendo en tu archivo README.md. Lo que ocurre después: Ya has completado las secciones esenciales de tu archivo README. Copilot no suele autogenerar texto de licencia específico a menos que se le indique en gran medida, por lo que es una buena idea añadir uno común manualmente. Si se ve diferente: Si necesitas una licencia diferente, puedes buscar en línea textos de licencias comunes (por ejemplo, "texto de la Licencia Apache 2.0") y copiar la declaración relevante en esta sección.

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