Uso del agente en la nube de GitHub Copilot para mejorar un proyecto

Introducción

El desarrollo moderno a menudo comienza con buenas intenciones: un script rápido, un prototipo, quizás una acción para automatizar una pequeña cosa. Pero a medida que evolucionan los proyectos, esos primeros esfuerzos pueden ser frágiles.

En este tutorial se muestra cómo puede usar agente en la nube de Copilot para mejorar un proyecto maduro, sin ralentizar su impulso.

En las secciones siguientes, haremos lo siguiente:

• Asegúrese de que el proyecto contiene instrucciones personalizadas que Copilot pueden usar para adaptar sus respuestas al proyecto.
• Asegúrese de que hay un archivo de configuración de entorno para agente en la nube de Copilot, de modo que pueda empezar a trabajar con tareas más rápidamente instalando previamente las dependencias del proyecto.
• Busque Copilot mejoras que se podrían realizar en el código y, a continuación, cree tareas para abordar esas mejoras.
• Delegue el trabajo de codificación a Copilot asignándolo a una tarea.

Comprobar las instrucciones personalizadas

1. Vaya al repositorio en GitHub.

2. Compruebe que existe al menos uno de los siguientes archivos de instrucciones personalizadas:

   • .github/copilot-instructions.md
   • .github/instructions/**/*-instructions.md
   • AGENTS.md

3. Si existe alguno de estos archivos, vea el archivo y compruebe que las instrucciones son adecuadas y actualizadas.

   Para obtener más información, vea la sección "Escribir instrucciones personalizadas eficaces" en Acerca de la personalización de las respuestas de GitHub Copilot y la biblioteca de ejemplos en Instrucciones personalizadas.

4. Si no hay archivos de instrucciones personalizados en el repositorio, use agente en la nube de Copilot para crear un .github/copilot-instructions.md archivo siguiendo las instrucciones de Agregar instrucciones personalizadas del repositorio para GitHub Copilot.

5. Revise la solicitud de incorporación de cambios que agente en la nube de Copilot crea. Compruebe que el .github/copilot-instructions.md archivo proporciona Copilot toda la información que necesita saber para trabajar en este proyecto.

   El archivo debe incluir:

   • Un resumen claro del código base y lo que hace el software.
   • Una visión general de la estructura del proyecto.
   • Directrices de contribución. Por ejemplo, cómo compilar, dar formato, aplicar lint y probar el código base y los requisitos que se deben cumplir antes de que se puedan combinar las solicitudes de incorporación de cambios.
   • Principios técnicos clave.

6. Edite el archivo según sea necesario.

7. Haga clic en Listo para su revisión en la parte inferior de la pestaña "Conversación" de la solicitud de incorporación de cambios y, a continuación, complete el proceso habitual para combinar una solicitud de incorporación de cambios.

2. Comprobación de un archivo de configuración del entorno

Un copilot-setup-steps.ymlGitHub Actions archivo de flujo de trabajo puede ayudar agente en la nube de Copilot a empezar a trabajar con tareas más rápidamente instalando previamente las dependencias que usa el proyecto.

La creación de este archivo es opcional, pero es una buena idea si usa agente en la nube de Copilot regularmente en el repositorio.

1. En el repositorio de GitHub, compruebe que existe el siguiente archivo:

   Text

   .github/workflows/copilot-setup-steps.yml
   

   Sugerencia

   Una manera rápida de hacer esto es copiar la ruta anterior, ir a la página principal del repositorio y pegar la ruta en el campo "Ir al archivo".

2. Si el archivo existe, ábrelo y comprueba que los pasos del flujo de trabajo instalan las dependencias correctas para el proyecto. Después de comprobarlo, puede omitir los pasos restantes de esta sección.

3. Si aún no tiene un archivo copilot-setup-steps.yml, siga estos pasos para que agente en la nube de Copilot lo cree por usted.

4. En la parte superior de cualquier página de su repositorio en el sitio web GitHub, haga clic en .

5. Copie y pegue la siguiente solicitud en el cuadro de diálogo de Agentes:

   Text

   Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for agente en la nube de Copilot, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`.
   

6. Haga clic o presione Entrar.

7. En la lista "Sesiones recientes del agente", haga clic en la nueva sesión del agente que se ha iniciado.

   Esto muestra un registro de actividad, a medida que Copilot trabaja en la tarea. Cuando Copilot termine, generará un resumen de lo que hizo.

8. Lea el resumen y haga clic en Ver solicitud de incorporación de cambios.

9. Opcionalmente, agregue Copilot como revisor. Para más información, consulta Uso de la revisión de código de GitHub Copilot. Copilot Espere a agregar comentarios de revisión y, a continuación, realice los cambios necesarios en respuesta a los comentarios.

10. Revise la solicitud de incorporación de cambios, asegurándose de que los pasos de configuración del nuevo archivo copilot-setup-steps.yml son correctos.

    El archivo de flujo de trabajo que Copilot ha creado debe incluir un on: workflow_dispatch desencadenador, para permitirle ejecutar el flujo de trabajo manualmente y el trabajo debe denominarse copilot-setup-steps como se muestra en este extracto:

    on:
      workflow_dispatch:
      push:
        paths:
          - .github/workflows/copilot-setup-steps.yml
      pull_request:
        paths:
          - .github/workflows/copilot-setup-steps.yml
    
    jobs:
      copilot-setup-steps:
        runs-on: ubuntu-latest
    

11. Realice los cambios necesarios en el copilot-setup-steps.yml archivo en la solicitud de incorporación de cambios.

    Puede pedirle a Copilot que realice cambios en un comentario de revisión mediante @copilot. Por ejemplo:

    @copilot - comment the file more thoroughly

12. Haga clic en Listo para su revisión en la parte inferior de la pestaña "Conversación" de la solicitud de incorporación de cambios y, a continuación, complete el proceso habitual para combinar una solicitud de incorporación de cambios.

13. Abra el archivo recién agregado .github/workflows/copilot-setup-steps.yml en el repositorio en GitHub.

14. Haga clic en Ver ejecuciones cerca de la parte superior derecha de la página.

15. Haga clic en Ejecutar flujo de trabajo y, a continuación, en Ejecutar flujo de trabajo en el cuadro de diálogo, para probar el nuevo flujo de trabajo.

16. Compruebe que el flujo de trabajo se ejecuta correctamente e instala las dependencias. Corrija los errores editando el archivo .github/workflows/copilot-setup-steps.yml.

3. Permite que Copilot encuentre la deuda técnica

Ahora que Copilot tiene el contexto adecuado y (opcionalmente) un entorno listo para usar, puede utilizarlo para identificar y priorizar la deuda técnica en su repositorio.

1. Haga clic en el botón del cuadro de solicitud siguiente para enviar este mensaje a Chat de Copiloto en GitHub.com.

   Copilot prompt

   What technical debt exists in this project? Give me a prioritized list of up to 5 areas we need to focus on. For each, describe the problem and its consequences.
   

2. Asegúrese de que el modo Preguntar está seleccionado.

3. Use la lista desplegable Todos los repositorios para seleccionar el repositorio.

4. Haga clic o presione Entrar.

5. Revise los detalles en la respuesta de Copilot.

6. Suponiendo que Copilot ha identificado al menos un área para mejorar, copie el siguiente mensaje en la misma conversación:

   Copilot prompt

   /create-issue
   
   Create a GitHub issue to address the first of the problem areas that you identified.
   
   If the problem area requires substantial work, create one main issue for the entire problem area and then sub-issues that allow the work to be split up into manageable chunks, which will be tackled in separate pull requests that can be easily reviewed. For a large body of work, do not create a single issue that attempts to address the entire problem.
   
   The issue, or each sub-issue if these are created, must include a description of the problem, a set of acceptance criteria, and pointers on what files need to be added/updated.
   

7. Edite este mensaje según sea necesario. Por ejemplo, dependiendo de la respuesta generada, es posible que Copilot desee trabajar en otra de las áreas problemáticas identificadas Copilot , en lugar de en la primera.

8. Asegúrese de que el modo Preguntar todavía está seleccionado ().

9. Haga clic o presione Entrar.

10. Revise el borrador que Copilot genera y edítelo según sea necesario.

11. Si Copilot crea una única incidencia de borrador que indica que se deben crear subincidencias, pida a Copilot que lo haga por usted:

    Copilot prompt

    Go ahead and create sub-issues that chunk this work into manageable pieces.
    

12. Haga clic en Crear o Revisar y crear, dependiendo de cuántas incidencias se hayan creado.

           Copilot crea uno o varios problemas nuevos en su nombre. Se le mostrará como autor de la incidencia.
    

4. Obtener Copilot para corregir un problema

Ahora que ha creado incidencias, el siguiente paso es asignar una incidencia a Copilot y revisar la solicitud de pull generada.

1. Abra uno de los problemas que Copilot creó automáticamente en la sección anterior.

2. Compruebe que el problema contiene criterios de aceptación que Copilot pueden usar para comprobar que ha completado la tarea.

3. Realice los cambios que sienta necesarios para describir con precisión el problema que debe corregirse y el resultado esperado del trabajo sobre este problema.

4. Haga clic en Asignar a Copilot.

5. En "Asignar Copilot a incidencia", haga clic en Asignar.

          Copilot comenzará a trabajar en el problema. Después de unos instantes, se agregará a la incidencia un vínculo a un borrador de solicitud de incorporación de cambios.
   

6. Haga clic en el vínculo al borrador de la solicitud de incorporación de cambios.

   Una vez Copilot que haya terminado de trabajar en la solicitud de incorporación de cambios, quitará "[WIP]" del título de la solicitud de incorporación de cambios y te agregará como revisor.

   Puede dejar Copilot para trabajar de forma asincrónica en la solicitud de incorporación de cambios y volver a revisarla una vez que le agreguen como revisor.

7. Opcionalmente, después de que Copilot haya estado trabajando durante un par de minutos, puede hacer clic en Ver sesión en la solicitud de incorporación de cambios para ver un registro de lo que Copilot está haciendo.

8. Opcionalmente, en la pestaña "Conversación" de la solicitud de incorporación de cambios, agregue Copilot como revisor.

9. Una vez que se haya agregado como revisor, revise los cambios usted mismo y realice los cambios necesarios.

   Puede solicitar que Copilot realice cambios empleando @copilot en un comentario de revisión.

10. Haga clic en Listo para su revisión en la parte inferior de la pestaña "Conversación" de la solicitud de incorporación de cambios y, a continuación, complete el proceso habitual para combinar una solicitud de incorporación de cambios.

5. Iteración en este proceso

1. Si Copilot creó varios problemas, repita la sección 4 y asígnelo Copilot a uno de los otros problemas.
2. Después de cerrar todos los problemas creados Copilot , repita la sección 3, eligiendo otro área de problemas e iterando en la sección 4 para asignar problemas a Copilot y revisar y combinar sus cambios.

Conclusión

          agente en la nube de Copilot puede ayudarle a mejorar la calidad del código en cualquier proyecto, pero es especialmente útil para reducir la deuda técnica en un proyecto que ha crecido orgánicamente durante muchos meses o años. Al usar agente en la nube de Copilot, puede realizar mejoras para las que podría haber tenido dificultades para encontrar tiempo sin que un asistente de IA trabaje en su nombre.

          Copilot no le reemplaza como desarrollador, todavía debe participar en todos los pasos de este proceso, especificando lo que desea Copilot hacer y revisando cuidadosamente el código que cambia o agrega, pero le permite implementar mejoras al mismo tiempo que trabaja en otras tareas importantes.

Pasos siguientes

Lea este caso de estudio en el GitHub blog: Cómo el equipo de facturación del GitHub utiliza el agente de nube en GitHub Copilot para reducir continuamente la deuda técnica.