Использование облачного агента GitHub Copilot для улучшения проекта

Введение

Современная разработка часто начинается с благих намерений: быстрый скрипт, прототип, возможно, действие для автоматизации одной маленькой задачи. Но по мере развития проектов эти ранние усилия могут становиться хрупкими.

В этом уроке показано, как Copilot облачный агент можно улучшить зрелый проект, не замедляя свой импульс.

В следующих разделах мы рассмотрим:

• Убедитесь, что в проекте есть собственные инструкции, которые Copilot можно использовать для адаптации ответов под ваш проект.
• Убедитесь, что есть файл настройки среды для Copilot облачный агент, чтобы он мог быстрее приступать к задачам, предварительно установив зависимости вашего проекта.
• Искать Copilot улучшения кода и создавать проблемы для этой работы.
• Делегируйте работу Copilot по программированию, назначив её на конкретный выпуск.

1. Проверьте индивидуальные инструкции

1. Перейдите в свой репозиторий на GitHub.

2. Проверьте, существует ли хотя бы один из следующих пользовательских файлов инструкций:

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

3. Если существует какой-либо из этих файлов, просмотрите файл и проверьте, что инструкции адекватны и актуальны.

   Для получения дополнительной информации см. раздел «Написание эффективных пользовательских инструкций» в О кастомизации ответов GitHub Copilot, а также библиотеку примеров на AUTOTITLE.

4. Если в репозитории нет пользовательских файлов инструкций, используйте Copilot облачный агент для создания .github/copilot-instructions.md файла, следуя инструкциям в Добавление пользовательских инструкций репозитория для GitHub Copilot.

5. Просмотрите pull request, который Copilot облачный агент создаёт. Проверьте, содержит .github/copilot-instructions.mdCopilot ли файл всю необходимую информацию для работы над этим проектом.

   Файл должен включать:

   • Четкое описание кодовой базы и того, что делает программное обеспечение.
   • Обзор структуры project.
   • Правила взносов. Например, как собирать, форматировать, использовать и тестировать кодовую базу, а также какие требования должны быть выполнены перед объединением pull-запросов.
   • Ключевые технические принципы.

6. Редактируйте файл по мере необходимости.

7. Нажмите «Готовы для просмотра » внизу вкладки «Conversation» pull-запроса, затем выполните обычный процесс слияния pull request.

2. Проверьте наличие файла настройки среды

          `copilot-setup-steps.yml`
          GitHub Actions Файл рабочего процесса помогает Copilot облачный агент быстрее приступить к задачам, предварительно установив зависимости, используемые проектом.

Создание этого файла необязательно, но хорошая идея, если вы регулярно его Copilot облачный агент используете в репозитории.

1. В вашем репозитории на GitHub, проверьте, существует ли следующий файл:

   Text

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

   Совет

   Быстрый способ to do — скопировать вышеуказанный путь, перейти на главную страницу вашего репозитория и вставить путь в поле «Перейти к файлу».

2. Если файл существует, откройте его и проверьте, что шаги в рабочем процессе устанавливают правильные зависимости для вашего Project. После проверки этого вы можете пропустить оставшиеся шаги в этом разделе.

3. Если у вас ещё нет файла copilot-setup-steps.yml , используйте следующие шаги, чтобы Copilot облачный агент создать его для себя.

4. В верхней части любой страницы вашего репозитория на GitHub сайте нажмите .

5. Скопируйте и вставьте следующий запрос в диалог «Агенты»:

   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 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. Нажмите или нажмите Enter.

7. В списке «Недавние сессии агента» нажмите на новую сессию агента, которая началась.

   Это отображает журнал активности, как Copilot работа над задачей. После Copilot завершения он сгенерирует сводку того, что он сделал.

8. Прочитайте сводку, затем нажмите «Просмотреть pull request».

9. По выбору добавляйте Copilot как рецензент. Дополнительные сведения см. в разделе Использование обзора кода на GitHub Copilot. Дождитесь Copilot добавления комментариев к отзывам, затем внесите любые изменения, которые считаете необходимыми в ответ на них.

10. Проверьте pull request самостоятельно, убедившись, что шаги настройки в новом copilot-setup-steps.yml файле правильны.

    Созданный файл Copilot workflow должен содержать on: workflow_dispatch триггер, чтобы вы могли запускать процесс вручную, и задача должна быть названа copilot-setup-steps так, как показано в этом извлечении:

    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. Внесите необходимые изменения в copilot-setup-steps.yml файл в pull request.

    Вы можете попросить Copilot внести изменения за вас, написав @copilot в комментарии к отзыву. Рассмотрим пример.

    @copilot - comment the file more thoroughly

12. Нажмите «Готовы для просмотра » внизу вкладки «Conversation» pull-запроса, затем выполните обычный процесс слияния pull request.

13. Откройте новый .github/workflows/copilot-setup-steps.yml файл в вашем репозитории на GitHub.

14.        **Нажмите «Просмотр работ»** в правом верхнем углу страницы.
    

15. Нажмите «Запустить рабочий процесс », а затем «Запустить рабочий процесс » в диалоговом диалоге, чтобы протестировать новый рабочий процесс.

16. Проверьте, что рабочий процесс работает корректно и устанавливает зависимости. Исправьте любые сбои, отредактировав файл .github/workflows/copilot-setup-steps.yml.

3. Найдим Copilot технический долг

Теперь, когда это Copilot имеет правильный контекст и (по желанию) готовую к использованию среду, вы можете использовать её для выявления и приоритетизации технического долга в вашем репозитории.

1. Нажмите кнопку в следующем поле с подсказкой, чтобы отправить этот запрос на 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. Убедитесь, что режим Ask выбран.

3. Используйте выпадающее меню All repositories , чтобы выбрать репозиторий.

4. Нажмите или нажмите Enter.

5. Ознакомьтесь с деталями в Copilotответе '.

6. Если Copilot вы выявили хотя бы одну область для улучшения, скопируйте следующий запрос в тот же разговор:

   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. Отредактируйте этот запрос по необходимости. Например, в зависимости от возникшей реакции Copilot , возможно, стоит заняться другой проблемной областью, которая Copilot была выявлена, а не первой.

8. Убедитесь, что режим Ask всё ещё выбран ().

9. Нажмите или нажмите Enter.

10. Просмотрите черновик, который Copilot появляется, и редактируйте его по мере необходимости.

11. Если Copilot возникает одна черновиковая задача, указывающая на необходимость создания подвыпусков, запросите Copilot сделать это за вас:

    Copilot prompt

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

12. Нажмите «Создать» или «Пересмотреть и создать» — в зависимости от количества подготовленных выпусков.

           Copilot создает одну или несколько новых проблем от вашего имени. Вы будете показаны как автор выпуска.
    

4. Решите Copilot проблему

Теперь, когда проблемы созданы, следующий шаг — делегировать её и Copilot пересмотреть полученный pull request.

1. Откройте одну из проблем, которые Copilot возникли для вас в предыдущем разделе.

2. Проверьте, содержит ли выпуск критерии приема, которые Copilot можно использовать для подтверждения выполнения задачи.

3. Внесите любые изменения, которые считаете необходимыми, чтобы точно описать проблему, которую нужно устранить, и ожидаемый результат работы по этой проблеме.

4. Нажмите «Назначить на Copilot.

5. В разделе «Assign Copilot to issue» нажмите Assign.

          Copilot начну работать над этим вопросом. Через несколько минут к выпуску появится ссылка на черновик pull request.
   

6. Перейдите по ссылке на черновик pull request.

   После Copilot завершения работы над pull-запросом будет удаляно «[WIP]» из названия pull request и добавляет вас в качестве рецензента.

   Вы можете работать Copilot над pull-запросом асинхронно, а после добавления вас в качестве рецензента вернуться и пересмотреть его.

7. По желанию, после Copilot нескольких минут работы можно нажать «Посмотреть сессию » в pull request, чтобы увидеть журнал происходящего Copilot .

8. По желанию, на вкладке «Conversation» в pull-запросе добавьте Copilot как рецензент.

9. После того как вас добавили в качестве рецензента, самостоятельно проверьте изменения и внесите необходимые изменения.

   Вы можете попросить Copilot внести изменения за вас, написав @copilot в комментарии к отзыву.

10. Нажмите «Готовы для просмотра » внизу вкладки «Conversation» pull-запроса, затем выполните обычный процесс слияния pull request.

5. Повторяйте этот процесс

1. Если Copilot возникло несколько выпусков, повторите раздел 4, назначив Copilot одну из других проблем.
2. После закрытия всех возникших проблем Copilot повторите раздел 3, выберите другую проблемную область и повторяйте раздел 4, чтобы назначить задачи Copilot , пересмотреть и объединить изменения.

Conclusion

          Copilot облачный агент Это может помочь улучшить качество кода в любом проекте, но особенно полезно для снижения технической задолженности в проекте, который органично развивался на протяжении многих месяцев или лет. Используя Copilot облачный агент, вы сможете внести улучшения, на которые могли бы сложно найти время без ИИ-помощника, который будет работать от вашего имени.

          Copilot Это не заменяет вас как разработчика — вам всё равно нужно участвовать на каждом этапе процесса, уточняя, что хотите Copilot делать, и внимательно анализируя код, который он изменяет или добавляет — но позволяет внедрять улучшения одновременно с другими важными задачами.

Дальнейшие шаги

Прочитайте GitHub этот кейс-стади в блоге: Как GitHub команда по выставлению счетов использует IN Облачный агентGitHub Copilot , чтобы постоянно сжигать технический долг.