Uso de GitHub Copilot para código base

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

En este artículo

Presentación

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

Trabajo con chat de Copilot

En esta guía, trabajaremos utilizando chat de Copilot en GitHub.com, que puede encontrar en GitHub.com/copilot.

Adjuntar un código base

Antes de que chat de Copilot pueda ayudarle, debe adjuntar el código base que desea explorar.

  1. En , vaya a GitHub.com/copilot.
  2. En el cuadro de texto, haga clic en Agregar repositorios, archivos y espacios y, a continuación, haga clic en Repositorios.
  3. Busque y seleccione el repositorio que desea explorar.

chat de Copilot ahora tiene acceso al código de ese repositorio y puede empezar a formular preguntas sobre él.

Ejemplos de indicaciones

Los mensajes siguientes son ejemplos del tipo de preguntas que puede formular a Copilot para ayudarle 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á del código base que esté 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

Use Copilot para ayudarle 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. Vaya al directorio en GitHub.com.

  2. En la esquina superior derecha de la página, haga clic en el icono Copilot () para abrir chat de Copilot.

    Copilot usará el contenido del directorio como contexto para su pregunta.

  3. Pregunte 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. En la esquina superior derecha de la página, haga clic en el icono Copilot () para abrir chat de Copilot.

    Copilot usará el contenido del archivo como contexto para su pregunta.

  3. Para un archivo pequeño, pregunte 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.

Descripción de líneas de código específicas

Usa {data variables.product.prodname_copilot_short %} para que te ayude a entender líneas de código específicas de un archivo.

Para obtener información sobre una línea de código específica:

  1. En , vaya a un repositorio y abra un archivo.

  2. Para seleccionar las líneas, haz clic en el número de línea de la primera línea que desees seleccionar, mantén pulsada la tecla Mayúsculas y haz clic en el número de línea de la última línea que quieras seleccionar.

  3. Para hacer tu propia pregunta sobre las líneas seleccionadas, haz clic en el icono Copilot () a la derecha de tu selección. Esto muestra el panel Chat de GitHub Copilot con las líneas seleccionadas indicadas como el contexto de tu pregunta.

  4. Para hacer una pregunta predefinida, haz clic en el botón que apunta hacia abajo situado junto al icono Copilot y elige una de las opciones.

    Captura de pantalla de los botones Copilot, resaltados con un contorno naranja oscuro, a la derecha de algunos códigos seleccionados .

  5. Si has hecho clic en el icono de Copilot, escribe una pregunta en el cuadro de indicaciones situado en la parte inferior del panel de chat y presiona Entrar.

Descripción de un archivo o símbolo específico

Usa Copilot para ayudarte a comprender el propósito de los archivos de un archivo o símbolo específico en el código base. Un símbolo es una entidad con nombre en el código, como una función, una clase o una variable.

  1. En , vaya a un repositorio y abra un archivo.

  2. En la parte superior del archivo, haga clic en el icono Copilot () para abrir chat de Copilot.

    Copilot desplegará el contenido del archivo en una pantalla dividida como contexto para su pregunta.

  3. Si desea preguntar sobre un símbolo específico, resalte el símbolo en el archivo.

  4. En el cuadro de solicitud, escriba una pregunta sobre el archivo o el símbolo resaltado y presione Entrar.

    Copilot responde en el panel de chat.

    Sugerencia

    La capacidad de Copilot para responder a preguntas en lenguaje natural como estas en el contexto de un repositorio se optimiza cuando el índice de búsqueda semántica de código para el repositorio está actualizado. Para más información, consulta Indexación de repositorios para GitHub Copilot Chat.

Obtener información sobre las confirmaciones

Una buena manera de familiarizarse con un proyecto es examinar el trabajo reciente. Para ello, vaya 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 commits.

    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. Haga clic en un mensaje de confirmación para mostrar una vista de diferencias para esa confirmación.

  4. En el panel chat de Copilot, escriba: What does this commit do?.

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

Uso de la pestaña Información

Además de usar Copilot para ayudarle a familiarizarse con un proyecto, también puede usar la pestaña Información de GitHub.com. Esto proporciona información general 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

  •         [AUTOTITLE](/copilot/using-GitHub-copilot/copilot-chat/asking-GitHub-copilot-questions-in-GitHub)