Verwenden von GitHub Copilot Cloud Agent zur Verbesserung eines Projekts

Einleitung

Moderne Entwicklung beginnt oft mit guten Absichten: ein schnelles Skript, ein Prototyp, vielleicht eine Aktion, um eine kleine Sache zu automatisieren. Aber wenn sich Projekte entwickeln, können diese frühen Anstrengungen brüchig werden.

Dieses Tutorial zeigt, wie Sie mit Copilot-Cloud-Agent ein reifes Projekt verbessern können, ohne Ihre Dynamik zu verlangsamen.

In den folgenden Abschnitten werden wir Folgendes ausführen:

• Stellen Sie sicher, dass das Projekt benutzerdefinierte Anweisungen enthält, die Copilot zum Anpassen der Antworten auf Ihr Projekt verwendet werden können.
• Stellen Sie sicher, dass eine Umgebungsdatei für Copilot-Cloud-Agent vorhanden ist, damit es schneller mit Aufgaben beginnen kann, durch die Vorinstallation der Abhängigkeiten Ihres Projekts.
• Untersuchen Sie Copilot auf Verbesserungen, die am Code vorgenommen werden können, und erstellen Sie dann Aufgaben für diese Aufgaben.
• Delegieren Sie die Codierungsarbeit, Copilot indem Sie sie einem Problem zuweisen.

1. Die benutzerdefinierten Anweisungen prüfen

1. Wechseln Sie zu Ihrem Repository auf GitHub.

2. Überprüfen Sie, ob mindestens eine der folgenden Anweisungsdateien vorhanden ist:

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

3. Wenn eine dieser Dateien vorhanden ist, zeigen Sie die Datei an, und überprüfen Sie, ob die Anweisungen angemessen und auf dem neuesten Stand sind.

   Weitere Informationen finden Sie im Abschnitt "Schreiben effektiver benutzerdefinierter Anweisungen" in Informationen zum Anpassen der GitHub Copilot-Antworten und in der Bibliothek von Beispielen unter Benutzerdefinierte Anweisungen.

4. Wenn im Repository keine benutzerdefinierten Anweisungsdateien vorhanden sind, verwenden Sie Copilot-Cloud-Agent zum Erstellen einer .github/copilot-instructions.md-Datei und folgen Sie den Anweisungen in Hinzufügen von benutzerdefinierten Repositoryanweisungen für GitHub Copilot.

5. Überprüfen Sie die Pull-Anfrage, die Copilot-Cloud-Agent erstellt. Überprüfen Sie, ob die .github/copilot-instructions.md Datei alle Informationen enthält Copilot , die sie kennen müssen, um an diesem Projekt zu arbeiten.

   Die Datei sollte Folgendes enthalten:

   • Eine klare Zusammenfassung der Codebasis und der Funktionsweise der Software.
   • Übersicht über die Projektstruktur.
   • Beitragsrichtlinien. Beispiel: Erstellen, Formatieren, Linten und Testen der Codebasis und Anforderungen, die erfüllt werden müssen, bevor Pullanforderungen zusammengeführt werden können.
   • Wichtige technische Prinzipien.

6. Bearbeiten Sie die Datei nach Bedarf.

7. Klicken Sie unten auf der Registerkarte „Unterhaltung“ der Pull-Anforderung auf Bereit für Überprüfung, und führen Sie dann Ihren üblichen Prozess zum Zusammenführen einer Pull-Anforderung aus.

2. Überprüfen einer Umgebungseinrichtungsdatei

Eine copilot-setup-steps.ymlGitHub Actions-Workflowdatei kann Copilot-Cloud-Agent dabei helfen, Aufgaben schneller zu beginnen, indem die Abhängigkeiten, die vom Projekt verwendet werden, vorab installiert werden.

Das Erstellen dieser Datei ist optional, ist aber eine gute Idee, wenn Sie regelmäßig im Repository verwenden Copilot-Cloud-Agent .

1. Überprüfen Sie in Ihrem Repository, GitHub ob die folgende Datei vorhanden ist:

   Text

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

   Tipp

   Eine schnelle Möglichkeit, dies zu tun, besteht darin, den obigen Pfad zu kopieren, auf die Hauptseite Ihres Repositories zu gehen und den Pfad in das Feld "Zur Datei wechseln" einzufügen.

2. Wenn die Datei vorhanden ist, öffnen Sie sie, und überprüfen Sie, ob die Schritte im Workflow die richtigen Abhängigkeiten für Ihre project installieren. Nachdem Sie dies überprüft haben, können Sie die verbleibenden Schritte in diesem Abschnitt überspringen.

3. Wenn Sie noch keine copilot-setup-steps.yml Datei haben, führen Sie die folgenden Schritte aus, damit Copilot-Cloud-Agent diese für Sie erstellt.

4. Klicken Sie oben auf einer beliebigen Seite Ihres Repositorys auf der GitHub Website auf .

5. Kopieren Sie die folgende Eingabeaufforderung, und fügen Sie sie in das Dialogfeld "Agents" ein:

   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-Cloud-Agent, 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. Klicken Sie oder drücken Sie die EINGABETASTE.

7. Klicken Sie in der Liste „Zuletzt verwendete Agent-Sitzungen“ auf die neue Agent-Sitzung, die gestartet wurde.

   Dadurch wird ein Aktivitätsprotokoll angezeigt, während Copilot an der Aufgabe arbeitet. Nach dem Abschluss von Copilot wird eine Zusammenfassung dessen generiert, was es getan hat.

8. Lesen Sie die Zusammenfassung, und klicken Sie dann auf "Pullanforderung anzeigen".

9. Optionalerweise können Sie Copilot als Rezensent hinzufügen. Weitere Informationen finden Sie unter Verwendung der GitHub Copilot-Codeüberprüfung. Warten Sie, bis Copilot die Rezensionskommentare hinzugefügt hat, und nehmen Sie dann alle notwendigen Änderungen als Reaktion auf die Kommentare vor.

10. Überprüfen Sie die Pullanforderung selbst, und stellen Sie sicher, dass die Setupschritte in der neuen copilot-setup-steps.yml Datei korrekt sind.

    Die erstellte Workflowdatei Copilot sollte einen on: workflow_dispatch Trigger enthalten, damit Sie den Workflow manuell ausführen können, und der Auftrag muss wie in diesem Extrakt dargestellt benannt copilot-setup-steps werden:

    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. Nehmen Sie alle erforderlichen Änderungen an der copilot-setup-steps.yml Datei in der Pullanforderung vor.

    Sie können Copilot bitten, Änderungen für Sie vorzunehmen, indem Sie @copilot in einem Überprüfungskommentar verwenden. Beispiel:

    @copilot - comment the file more thoroughly

12. Klicken Sie unten auf der Registerkarte „Unterhaltung“ der Pull-Anforderung auf Bereit für Überprüfung, und führen Sie dann Ihren üblichen Prozess zum Zusammenführen einer Pull-Anforderung aus.

13. Öffnen Sie die neu hinzugefügte .github/workflows/copilot-setup-steps.yml Datei in Ihrem Repository auf GitHub.

14. Klicken Sie oben rechts auf der Seite auf „Läufe anzeigen“.

15. Klicken Sie auf "Workflow ausführen " und dann im Dialogfeld " Workflow ausführen ", um den neuen Workflow zu testen.

16. Überprüfen Sie, ob der Workflow ordnungsgemäß ausgeführt wird, und installieren Sie die Abhängigkeiten. Beheben Sie Fehler, indem Sie die Datei .github/workflows/copilot-setup-steps.yml bearbeiten.

3. Lassen Sie Copilot technische Schulden ermitteln

Jetzt, da Copilot den richtigen Kontext und (optional) eine einsatzbereite Umgebung hat, können Sie ihn verwenden, um technische Schulden in Ihrem Repository aufzuzeigen und zu priorisieren.

1. Klicken Sie auf die Schaltfläche im folgenden Eingabefeld, um diese Eingabeaufforderung an Copilot-Chat zu GitHub.com zu senden.

   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. Stellen Sie sicher, dass der Fragemodus ausgewählt ist.

3. Verwenden Sie das Dropdownmenü "Alle Repositorys ", um Ihr Repository auszuwählen.

4. Klicken Sie oder drücken Sie die EINGABETASTE.

5. Überprüfen Sie die Details in Copilotder Antwort.

6. Wenn Sie Copilot mindestens einen Verbesserungsbereich identifiziert haben, kopieren Sie die folgende Aufforderung in das gleiche Gespräch.

   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. Bearbeiten Sie diese Eingabeaufforderung nach Bedarf. Abhängig davon, welche Antwort Copilot erzeugt wurde, möchten Sie möglicherweise an einem anderen Problembereich Copilot arbeiten, der ermittelt wurde, anstatt am ersten.

8. Stellen Sie sicher, dass der Fragemodus weiterhin ausgewählt ist ().

9. Klicken Sie auf oder drücken Sie die EINGABETASTE.

10. Überprüfen Sie die Entwurfsfrage, die Copilot generiert, und bearbeiten Sie sie nach Bedarf.

11. Wenn Copilot ein einzelnes Entwurfsthema erstellt, das darauf hinweist, dass Unterprobleme erstellt werden sollen, fordern Sie Copilot auf, dies für Sie zu tun.

    Copilot prompt

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

12. Klicken Sie auf Create oder Überprüfen und Erstellen, je nachdem, wie viele Entwürfe erstellt wurden.

           Copilot erstellt ein oder mehrere neue Probleme in Ihrem Auftrag. Sie werden als Urheber angezeigt.
    

4. Beauftragen Sie Copilot, um ein Problem zu beheben

Nachdem Sie Nun Probleme erstellt haben, besteht der nächste Schritt darin, ein Problem zu Copilot delegieren und die resultierende Pullanforderung zu überprüfen.

1. Öffnen Sie eines der Probleme, die Copilot im vorherigen Abschnitt für Sie erstellt wurden.

2. Überprüfen Sie, ob das Problem Akzeptanzkriterien enthält, die Copilot verwenden kann, um zu überprüfen, ob die Aufgabe abgeschlossen wurde.

3. Nehmen Sie alle Änderungen vor, die Sie benötigen, um das Problem, das behoben werden muss, genau zu beschreiben, und das erwartete Ergebnis der Arbeit an diesem Problem.

4. Klicken Sie auf Zuweisen zuCopilot.

5. Klicken Sie im Fenster "Copilot einer Aufgabe zuweisen" auf Zuweisen.

          Copilot wird mit der Bearbeitung des Problems beginnen. Nach einigen Momenten wird ein Link zu einem Entwurf einer Pull-Anforderung dem Problem hinzugefügt.
   

6. Klicken Sie auf den Link zur Entwurfs-Pull-Anfrage.

   Nachdem Copilot die Arbeit an der Pullanforderung abgeschlossen ist, wird "[WIP]" aus dem Titel der Pullanforderung entfernt und Sie als Prüfer hinzugefügt.

   Sie können die Arbeit an der Pullanforderung asynchron verlassen Copilot und zurückkehren, um die Pullanforderung zu überprüfen, sobald Sie als Prüfer hinzugefügt wurden.

7. Optionalerweise können Sie nach einigen Minuten auf die Pull Request klicken und "Sitzung anzeigen" auswählen, um ein Protokoll dessen, was Copilot gerade macht, zu sehen.

8. Optional können Sie auf der Registerkarte "Unterhaltung" der Pullanforderung Copilot als Prüfer hinzufügen.

9. Nachdem Sie als Prüfer hinzugefügt wurden, prüfen Sie die Änderungen selbst und nehmen jegliche erforderlichen Anpassungen vor.

   Sie können das Objekt Copilot bitten, Änderungen für Sie vorzunehmen, indem Sie es in einem Überprüfungskommentar verwenden @copilot.

10. Klicken Sie unten auf der Registerkarte „Unterhaltung“ der Pull-Anforderung auf Bereit für Überprüfung, und führen Sie dann Ihren üblichen Prozess zum Zusammenführen einer Pull-Anforderung aus.

5. Wiederholen Sie diesen Prozess

1. Wenn Copilot mehrere Probleme erstellt hat, wiederholen Sie Abschnitt 4 und weisen Sie Copilot einem der anderen Probleme zu.
2. Nachdem Sie alle von Copilot erstellten Probleme geschlossen haben, wiederholen Sie Abschnitt 3, wählen Sie einen anderen Problembereich aus und durchlaufen Sie Abschnitt 4, um die Probleme Copilot zuzuweisen und deren Änderungen zu überprüfen und zusammenzuführen.

Conclusion

          Copilot-Cloud-Agent kann Ihnen helfen, die Qualität von Code in jedem Projekt zu verbessern, aber es ist besonders nützlich, um die technische Schulden in einem Projekt zu reduzieren, das über viele Monate oder Jahre organisch gewachsen ist. Mithilfe von Copilot-Cloud-Agent können Sie Verbesserungen vornehmen, für die Sie möglicherweise ohne einen KI-Assistenten, der in Ihrem Auftrag arbeitet, nur schwer Zeit finden würden.

          Copilot ersetzt Sie nicht als Entwickler – Sie müssen immer noch an jedem Schritt dieses Prozesses beteiligt sein und angeben, was Sie tun möchten Copilot , und sorgfältig überprüfen sie den Code, den er ändert oder hinzufügt – aber es ermöglicht Es Ihnen, Verbesserungen gleichzeitig zu implementieren, während Sie an anderen wichtigen Aufgaben arbeiten.

Nächste Schritte

Lesen Sie diese Fallstudie auf dem GitHub-Blog: Wie das Abrechnungsteam das GitHubCloud-Agent in GitHub Copilot verwendet, um technische Schulden kontinuierlich abzubauen.