Uso de Copilot para explorar un código base

GitHub Copilot Chat puede ayudarte a comprender el contenido, la estructura y la funcionalidad de un código base.

En este artículo

Introducción

Si te han asignado para trabajar en un proyecto con el que no estás familiarizado o has encontrado un proyecto de código abierto interesante al que deseas contribuir, necesitarás conocer el código base para poder empezar a realizar cambios. En esta guía se muestra cómo usar GitHub Copilot Chat para explorar un código base y aprender rápidamente sobre el proyecto.

Trabajo con Copilot Chat

En esta guía, trabajaremos en GitHub.com, usando Copilot Chat en modo de asistencia, que muestra un panel de Copilot Chat en la esquina inferior derecha de la página actual en GitHub.com.

Puedes expandir el panel de Copilot Chat para proporcionar más espacio para mostrar las respuestas de Copilot, haciendo clic y arrastrando los bordes del panel.

Uso de las solicitudes predefinidas

Copilot Chat incluye un conjunto de mensajes predefinidos que pueden ayudarte a empezar a explorar un código base. Puedes usar las indicaciones haciendo clic en un botón en el panel de chat. Los botones se muestran al iniciar una nueva conversación con Copilot Chat. La selección de mensajes varía en función de la página mostrada actualmente en GitHub.com.

  1. Abre el repositorio que desea explorar en GitHub.com.

  2. Haz clic en la pestaña Código para mostrar la página principal del repositorio.

  3. Presiona Mayús+C para abrir Copilot Chat en modo de asistencia.

  4. Haz clic en el botón Tell me about this repository en el panel de chat.

    Captura de pantalla del panel de chat con el botón "Cuéntame sobre este repositorio" resaltado.

    Sugerencia

    Si no se muestra este botón, asegúrate de que estás en la página principal del repositorio y haz clic en el signo más () en la parte superior derecha del panel Copilot para iniciar una nueva conversación.

    Se envía un mensaje predefinido a Copilot y la respuesta se muestra en el panel de chat.

  5. Opcionalmente, después de leer la respuesta, haz clic en el signo más () en la parte superior derecha del panel Copilot para iniciar una nueva conversación y, a continuación, haz clic en Cómo empezar a trabajar con este repositorio.

Ejemplos de indicaciones

Las siguientes indicaciones son ejemplos del tipo de preguntas que puedes formular a Copilot para ayudarte a obtener información sobre un código base.

Preguntas generales

  • Based on the code in this repository, give me an overview of the architecture of the codebase. Provide evidence.

  • Which languages are used in this repo? Show the percentages for each language.

  • What are the core algorithms implemented in this repo?

  • What design patterns are used in this repository? Give a brief explanation of each pattern that you find, and an example of code from this repository that uses the pattern, with a link to the file.

Preguntas específicas

Si estas preguntas son útiles dependerán del código base que estás explorando.

  • How do I build this project?

  • Where is authentication handled in this codebase?

  • Analyze the code in this repository and tell me about the entry points for this application.

  • Describe the data flow in this application.

  • Analyze the code in this repository and tell me what application-level security mechanisms are employed. Provide references.

Descripción de los archivos de un directorio

Usa Copilot para ayudarte a comprender el propósito de los archivos de un directorio o archivos individuales.

Para obtener información sobre los archivos de un directorio:

  1. Ve al directorio en GitHub.com.
  2. Presiona Mayús+C para abrir Copilot Chat en modo de asistencia.
  3. Pregunta a Copilot: Explain the files in this directory.

Para obtener información sobre un archivo específico:

  1. Abre el archivo en GitHub.com.
  2. Presiona Mayús+C para abrir Copilot Chat en modo de asistencia.
  3. Para un archivo pequeño, pide a Copilot: Explain this file.
  4. Para un archivo grande, pregunta: Explain what this file does. Start with an overview of the purpose of the file. Then, in appropriately headed sections, go through each part of the file and explain what it does in detail.

Obtener información sobre las confirmaciones

Una buena manera de familiarizarse con un proyecto es examinar el trabajo reciente. Para ello, ve a las confirmaciones recientes.

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. En la página principal del repositorio, encima de la lista de archivos, haz clic en confirmaciones.

    Captura de pantalla de la página principal de un repositorio. Un icono de reloj y "178 confirmaciones" está resaltado con un contorno naranja.

  3. Haz clic en un mensaje de confirmación para mostrar una vista de diferencias para esa confirmación.

  4. En el panel Copilot Chat, escribe: What does this commit do?.

  5. Si es necesario, puedes continuar escribiendo: Explain in more detail.

Uso de la pestaña Insights

Además de usar Copilot para ayudarte a familiarizarte con un proyecto, también puedes usar la pestaña Insights de GitHub.com. Esto proporciona información general de alto nivel del repositorio.

Para más información, consulta Uso de Pulse para ver un resumen de la actividad del repositorio y Ver los colaboradores de un proyecto.

Información adicional