Cómo hacer prompt a los repositorios

En esta sesión práctica exploramos cómo generar prompts efectivos para obtener información valiosa desde repositorios de código, utilizando herramientas especializadas en combinación con Inteligencia Artificial, específicamente ChatGPT.

¿Qué es “hacer prompt” a un repositorio?

”Hacer prompt” a un repositorio significa transformar el código de un proyecto en información fácilmente comprensible y procesable por herramientas de Inteligencia Artificial. Esto permite a los desarrolladores obtener rápidamente contexto, documentación y orientación para implementar nuevas funcionalidades o entender mejor un proyecto existente.

Herramientas utilizadas en esta sesión:

Extensión de Visual Studio Code: eDev Summary

eDev Summary permite generar un archivo único que resume el contexto completo de un proyecto:

• Genera un archivo TXT que consolida todo el código del repositorio.
• Facilita la documentación del proyecto mediante resúmenes automáticos.
• Permite realizar consultas rápidas en ChatGPT con contexto completo del código.

Pasos para utilizar eDev Summary:

1. Instalar la extensión desde el marketplace de Visual Studio Code.
2. Configurar la extensión indicando la ruta del proyecto, las carpetas permitidas y excluidas.
3. Generar el archivo resumen y usarlo como input para consultas con ChatGPT.

Aplicaciones prácticas:

1. Desarrollo de nuevas funcionalidades:

Durante la transmisión, realizamos una prueba práctica implementando migraciones en un proyecto usando TypeORM. Gracias al contexto completo generado por la extensión, ChatGPT proporcionó:

• Guía paso a paso de la implementación.
• Ejemplos concretos de código.
• Sugerencias para mejorar la configuración y manejo de errores.

2. Generación automática de documentación:

Otra aplicación destacada fue la creación automática de documentación con diagramas UML. Usando el contexto generado se logró:

• Identificar procesos funcionales específicos.
• Generar diagramas UML de interacción (Interaction Overview Diagram).
• Crear diagramas de estado para representar el flujo de datos.

Ventajas del uso de Inteligencia Artificial en repositorios:

• Reducción del tiempo dedicado a entender y documentar proyectos.
• Facilita el onboarding de nuevos desarrolladores.
• Mejora la consistencia y calidad en el código y documentación.

Consideraciones importantes:

Aunque estas herramientas son muy poderosas, se destacó en la sesión la importancia de:

• Validar siempre la información generada por la IA.
• Consultar previamente el uso de estas herramientas con las políticas internas de la organización por temas de privacidad y seguridad.

📹 Video relacionado:

Más contenido

Sigue a TryCatch.tv en YouTube, Instagram, TikTok, Twitch, y LinkedIn / LinkedIn Personal.

---