Uso de GitHub Copilot para explorar un código base

Presentación

Si se le ha asignado para trabajar en una project con la que no está familiarizado, o ha encontrado una código abierto project interesante a la que desea contribuir, necesitará cierta comprensión del código base para poder empezar a realizar cambios. En esta guía se muestra cómo usar Copilot Chat de GitHub para explorar un código base y aprender rápidamente sobre el proyecto.

Trabajar con Chat de Copiloto

A lo largo de esta guía, trabajaremos con Chat de Copiloto en GitHub.com, que puedes encontrar en github.com/copilot.

Proporcionar contexto de repositorio

Puede preguntar Chat de Copiloto sobre un código base de cualquiera de estas maneras.

Adjuntar un repositorio al chat

Adjuntar un repositorio da a Chat de Copiloto acceso al código del repositorio y es la mejor opción cuando se desea comparar o alternar entre repositorios durante una conversación.

1. En GitHub, 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.

Hacer una pregunta desde la página del repositorio

Puede preguntar Chat de Copiloto sobre un repositorio directamente desde su página en GitHub, sin adjuntarlo primero. Esta es una manera rápida de orientarse en un proyecto en el que no ha trabajado antes.

1. En GitHub, vaya al repositorio que desea explorar.
2. Abra Chat de Copiloto desde la página del repositorio y haga una pregunta. Copilot usa el repositorio como contexto y fundamenta sus respuestas en los archivos y símbolos reales del repositorio.
3. Haga una pregunta de seguimiento para profundizar y usar el mismo contexto compartido.

Ejemplos de indicaciones

Las siguientes indicaciones son ejemplos del tipo de preguntas que puede formular Copilot para ayudarle a averiguar 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.

• Give me an overview of this repository: its purpose, structure, key components, and how to run it.

• What are the main entry points and how do the key components fit together?

• 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 Copiloto.

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

1. Pregunte Copilot: Explain the files in this directory.

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

1. Abra 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 Copiloto.

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

1. Para un archivo pequeño, pregunte a Copilot: Explain this file.
2. 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

Use Copilot para ayudarle a comprender líneas de código específicas en un archivo.

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

1. En GitHub, 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 su propia pregunta sobre las líneas seleccionadas, haga clic en el Copilot icono () a la derecha de la selección. Esto muestra el Copilot Chat de GitHub panel con las líneas seleccionadas indicadas como el contexto de la pregunta.

4. Para formular una pregunta predefinida, haga clic en el botón hacia abajo situado junto al Copilot icono y elija una de las opciones.

   

5. Si ha clic en el Copilot icono, escriba una pregunta en el cuadro de mensaje situado en la parte inferior del panel de chat y presione Entrar.

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

Use Copilot para ayudarle a comprender el propósito 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 GitHub, vaya a un repositorio y abra un archivo.

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

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

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

2. 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.

Obtener información sobre las confirmaciones

Una buena manera de familiarizarse con un proyecto es ver el trabajo reciente que se ha estado realizando. 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.

   

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

4. En el Chat de Copiloto panel, 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 Conclusiones 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

• Hacer preguntas a GitHub Copilot en GitHub