Beschleunigen von Pull-Anforderungen in Ihrem Unternehmen mit GitHub Copilot

Der Leitfaden ist inspiriert vom Engineering System Success Playbook (ESSP) von GitHub, das Strategien und Metriken für die Verbesserung von Engineeringsystemen empfiehlt.

Wenn du mit dem Rollout von Copilot beginnst, empfehlen wir, deine Ziele zu definieren, den Rollout entsprechend zu planen und die Ziele klar an Mitarbeitende zu kommunizieren. Weitere Informationen findest du unter Erreichen der Engineeringziele deines Unternehmens mit GitHub Copilot.

1. Identifizieren von Erfolgshindernissen

Der erste Schritt, der vom ESSP empfohlen wird, besteht darin, ein klares Verständnis der Hindernisse zu entwickeln, die Verbesserungen in deinem Unternehmen verhindern. Wenn du die aktuelle Baseline, den gewünschten zukünftigen Zustand und die Hindernisse für Fortschritt kennst, kannst du sicherstellen, dass Änderungen gezielt und effektiv sind.

Teams erleben häufig Verzögerungen beim Mergen von Pull Requests aufgrund langwieriger Reviewzyklen. Gründe für solche Verzögerungen sind oft:

• Komplexe Codeänderungen, die schwer zu verstehen sind
• Uneinheitliche Codeformatierung, die Überprüfungen erschwert
• Allgemein mangelnder Kontext zu den Änderungen
• Soziale Faktoren, die dazu beitragen, dass Reviews nur langsam erfolgen oder schwer zu adressieren sind

Reviewende können ebenfalls leicht kleine Fehler übersehen, die zu Produktionsproblemen führen können.

Das führt zu Engpässen im Entwicklungsprozess und verlangsamt die Gesamtbereitstellung sowie die Qualität der Features.

2. Auswerten der Optionen

Der nächste Schritt besteht darin, Lösungen für die in Schritt 1 identifizierten Hindernisse zu bewerten und auszuwählen. In diesem Leitfaden konzentrieren wir uns auf die Auswirkungen, die GitHub Copilot auf das von dir identifizierte Ziel haben kann. Erfolgreiche Rollouts eines neuen Tools erfordern auch Änderungen an Kultur und Prozessen.

Führen Sie Testversionen neuer Tools und Prozesse mit Pilotgruppen aus, um Feedback zu sammeln und den Erfolg zu messen. Schulungsressourcen und Metriken, die während der Testversion verwendet werden sollen, finden Sie in den Abschnitten 3. Implementieren Sie Änderungen und Metriken, die beobachtet werden sollen.

          <a href="/proxy/https/github.com/enterprise/contact?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline">
          <span>Vertrieb kontaktieren</span><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-link-external" aria-label="link external icon" role="img"><path d="M3.75 2h3.5a.75.75 0 0 1 0 1.5h-3.5a.25.25 0 0 0-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-3.5a.75.75 0 0 1 1.5 0v3.5A1.75 1.75 0 0 1 12.25 14h-8.5A1.75 1.75 0 0 1 2 12.25v-8.5C2 2.784 2.784 2 3.75 2Zm6.854-1h4.146a.25.25 0 0 1 .25.25v4.146a.25.25 0 0 1-.427.177L13.03 4.03 9.28 7.78a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042l3.75-3.75-1.543-1.543A.25.25 0 0 1 10.604 1Z"></path></svg></a>

Wie kann Copilot helfen

          GitHub Copilot bietet eine Reihe von Features, die entwickelt wurden, um den Prozess der Überprüfung von Pullanforderungen zu beschleunigen, die Codequalität zu verbessern und die Zusammenarbeit zu verbessern, was letztendlich zu schnelleren Zusammenführungszeiten führt.

Durch die Nutzung Copilotder Funktionen können Teams ihre Workflows optimieren, Reibung reduzieren und konsistenten, qualitativ hochwertigen Code sicherstellen.

Generiert vollständige und hilfreiche PR-Zusammenfassungen

          Copilot kann automatisch klare und präzise PR-Zusammenfassungen generieren und Entwicklern Zeit sparen und sicherstellen, dass der Zweck und die Änderungen der PR leicht von Prüfern verstanden werden. Das reduziert die Wahrscheinlichkeit von Missverständnissen und beschleunigt den Reviewprozess.

Unterstützt Überprüfenden während deren Überprüfungsprozess

          GitHub Copilot kann als effizientes PR-Überprüfungswerkzeug verwendet werden.

* Copilot kann dazu beitragen, komplexe Codeänderungen zu erläutern, damit Prüfer schneller verstehen, was die PR leistet. * Copilot kann repositoriesweite, kontextbezogene Vorschläge und potenzielle Codeverbesserungen direkt in der Pull-Anforderungsüberprüfungsschnittstelle GitHub bereitstellen, wodurch Prüfer effizienter potenzielle Probleme erfassen und konstruktives Feedback geben können. * Copilot kann Bearbeitern helfen, klare, konsistente und effektive Rezensionskommentare zu entwerfen und zu schreiben.

Bewertungen auf Grundlage der Organisationsrichtlinien

•         Copilot kann Codeänderungen in Ihrer IDE überprüfen, bevor Sie einen Pull-Request öffnen oder einem Pull-Request als Prüfer zugewiesen werden.
  

• Mit Regelsätzen können Sie einrichten Copilot , um Pullanforderungen basierend auf benutzerdefinierten Kriterien systematisch zu überprüfen.
• Mit benutzerdefinierten Anweisungen für Rezensionen Copilot können Sie Codierungsstandards und bewährte Methoden der Organisation erzwingen, potenzielle Verstöße automatisch kennzeichnen und Korrekturen vorschlagen.

Diese Features sorgen für Konsistenz innerhalb der Codebasis und helfen dir, Fehler frühzeitig im Entwicklungsprozess abzufangen. Das senkt wiederum die Notwendigkeit manueller Code Reviews und spart Programmierenden und Reviewenden Zeit.

Schlägt Codekorrekturen vor

Basierend auf einem Kommentar zur Überprüfung von Pull-Requests kann Copilot Autoren von Pull-Requests helfen, schnell die erforderlichen Codeänderungen zu implementieren, um die Überprüfung abzuschließen.

Kulturelle Überlegungen

Neben der Einführung von GitHub Copilot solltest du dich mit allen sozialen oder kulturellen Faktoren auseinandersetzen, die dich daran hindern könnten, deine Ziele zu erreichen.

Die folgenden Beispiele stammen aus dem Abschnitt „Anti-Patterns“ im ESSP.

• Teams können unter Umständen zu lang mit dem Release warten und dann sehr große Codebatches gleichzeitig bereitstellen. Grund dafür können z. B. die Angst vor einer Destabilisierung durch häufige Releases, die fehlende Reife der CI/CD-Pipelines oder strenge Complianceanforderungen sein.
• Programmierende verbringen möglicherweise zu viel Zeit mit der Codeperfektierung oder fügen unnötige Features hinzu. Das kann durch eine Kultur des Perfektionismus oder durch einen Mangel an effektiver Priorisierung verursacht werden.
• Programmierende können übermäßig komplexe Lösungen für einfache Probleme erstellen. Das kann durch den Wunsch nach einer unnötig hohen Zukunftssicherheit oder durch den Druck verursacht werden, den Wert durch Komplexität zu steigern.

3. Implementieren von Änderungen

Wenn Sie den richtigen Ansatz identifiziert haben, um Ihre Barrieren zu überwinden, skalieren Sie die von Ihnen identifizierten Lösungen. Wenn Sie ein neues Tool oder einen neuen Prozess erfolgreich einführen möchten, weisen Sie jedem Teil des Rollouts Den Besitz zu, kommunizieren Sie transparent über Ihre Ziele, stellen Sie effektive Schulungen bereit und messen Sie Ihre Ergebnisse.

Dieser Abschnitt enthält Beispielszenarien, bewährte Methoden und Ressourcen für Entwickelnde. Verwenden Sie diesen Abschnitt, um Kommunikations- und Schulungssitzungen zu planen , damit Mitarbeiter Copilot auf eine Weise verwenden können, die ihrem Ziel entspricht.

•         [Erstellen hilfreicher Zusammenfassungen für Pull Requests](#create-helpful-pull-request-summaries)
  

•         [Als Prüfassistent verwenden Copilot](#use-copilot-as-a-review-assistant)
  

•         [Als Bearbeiter hinzufügen Copilot](#add-copilot-as-a-reviewer)
  

•         [Anfordern von Hilfe bei der Implementierung von Reviewkommentaren](#get-help-implementing-review-comments)
  

•         [Best Practices für Programmierende](#best-practices-for-developers)
  

•         [Ressourcen](#resources)
  

Erstellen Sie hilfreiche Zusammenfassungen für Pull Requests

1. Klicken Sie beim Erstellen einer Pullanforderung auf das Copilot Symbol im Feld "Beschreibung hinzufügen", und klicken Sie dann auf "Zusammenfassung".

2.        Copilot scannt die Pullanfrage und bietet einen Überblick über die Änderungen, die im Fließtext vorgenommen wurden, sowie eine Aufzählung der Änderungen mit den Dateien, die sie betreffen.
   

3. Überprüfen Sie, ob Sie mit der Beschreibung von Copilot zufrieden sind.
4. Wenn Reviewende deinen Pull Request öffnen, finden sie den gesamten Kontext vor, den sie für den Review benötigen.

Als Prüfassistent verwenden Copilot

Wenn Sie als Prüfer zu einer Pullanfrage springen, können Copilot Sie Ihre Rezension beschleunigen.

1. Verwenden Sie Copilot, um die Änderungen im Pull Request zu verstehen.

   • Bitten Sie Copilot, die Änderungen an einer Datei zusammenzufassen, was besonders bei längeren Differenzen hilfreich ist. Sie können eine bestimmte Datei aus dem Diff auswählen, indem Sie auf die obere rechte Ecke der Datei klicken .

     

   • Wenn Sie Änderungen an bestimmten Zeilen vornehmen möchten, markieren Sie die Zeilen, die Sie besser verstehen möchten, und bitten Copilot Sie, die Änderungen für Sie zu erläutern. Du kannst mehrere Zeilen markieren, indem du auf die oberste Zeilennummer klickst, die UMSCHALTTASTE gedrückt hältst und dann auf die unterste Zeile des diffs klickst.

     

2.        **Arbeiten Sie gemeinsam an Ihrer PR-Bewertung** mitCopilot. Vergessen Sie nicht, die spezifischen Datei-Diffs an die Unterhaltung anzufügen, bevor Sie Copilot auffordern.
   

   • Sie können Copilot nach seiner eigenen Meinung zu den PR-Änderungen fragen, indem Sie fragen: Provide your judgement as a PR Reviewer, both for functional and non-functional aspects that these changes bring. Beachten Sie, dass diese Aufforderung sowohl Copilot funktionale als auch nicht funktionale Aspekte des Codes berücksichtigen muss.

   • Bitten Sie Copilot für Ihre eigenen PR-Bewertungskommentare um eine zweite Meinung: As my peer reviewer on this pull request, give me your feedback on my own review: YOUR-REVIEW-COMMENT. Do you think it's pertinent? Am I missing something?

3. Arbeiten Sie mit Copilot ihnen zusammen, um Ihre Rezensionskommentare zu entwerfen und zu verfeinern.

   • Nach der Planung der Besprechung mit Copilot können Sie darum bitten, die Kommentare, die Sie bereitstellen sollten, auflisten zu lassen: Make a list of review comments to add to the PR and tell me exactly in which file diff and lines each comment should be added.
   • Sie können Copilot auch darum bitten, einen ersten Entwurf eines Rezensionskommentars zu erstellen, den Sie im Sinn haben, oder einen Kommentar verfeinern, bevor Sie ihn posten: Help me draft review comments as discussed oder Refine this review comment to make it clear, concise, and actionable.

Als Prüfer Copilot hinzufügen

Um Überprüfungszeiten zu reduzieren und Pullanforderungen schneller zusammenzuführen, verwenden Sie Copilot Codeüberprüfungen systematisch: zuerst in der IDE vor dem Öffnen der Pullanforderung und dann in der PR in GitHub.

Die Verwendung der Copilot Codeüberprüfung ersetzt nicht die Notwendigkeit für die Überprüfung von menschlichem Code. Die oben aufgeführten Schritte können Menschen jedoch helfen, Reviews schneller abzuschließen.

•         **Entwickler** sollten eine Überprüfung aller änderungen mithilfe Copilot der Codeüberprüfung anfordern, bevor Sie eine Pull-Anforderung öffnen.
  

•         **Administratoren** sollten Repository- oder Organisationsregeln einrichten, die Copilot automatisch als Prüfer zu allen Pull-Anfragen hinzufügen, die auf geschützte Zweige abzielen.
  

•         **Teamleiter** sollten den Standardstil und die Regeln ihres Teams erfassen und als benutzerdefinierte Anweisungen für die Organisation festlegen, Copilot damit sie in Rezensionen genutzt werden können.
  

  • Stelle sicher, dass deine benutzerdefinierten Anweisungen eine Mindestmenge von Formatierungsempfehlungen erfassen, die den Code besser lesbar machen, was während des Reviewprozesses für Pull Requests hilfreich ist.
  • Um die Menge der PR-Rezensionskommentare aufgrund von Formatierungsproblemen zu verringern, legen Sie die gleichen Empfehlungen in Copilot Anweisungen auf Repository- und Organisationsebene fest. Auf diese Weise wird der durch Copilot generierte Code diesen Richtlinien entsprechen.

Hilfe bei der Umsetzung von Überprüfungskommentaren anfordern

Autoren von Pull-Anforderungen können die Auflösung von PR-Prüfungskommentaren beschleunigen, indem sie mithilfe von Copilot schnell Korrekturen implementieren.

• Für alle Überprüfungskommentare, die von Copilot selbst hinterlassen wurden, entweder die vorgeschlagene Korrektur direkt übernehmen oder es im Copilot-Workspace bearbeiten, bevor es abgeschlossen wird.
• Navigieren Sie für alle von Kollegen hinterlassene Überprüfungskommentare zum Dateidiff, der sich auf den Überprüfungskommentar bezieht, und hängen Sie den Diff in ein Copilot-Chat Gespräch an. Kopiere dann den Reviewkommentar mit einem Prompt wie dem folgenden: Suggest a fix for this review comment:.
• Wenn Sie VS Code verwenden, bitten Sie GitHub Copilot im Agentenmodus, die erforderlichen Änderungen aus dem Überprüfungskommentar zu implementieren.

Bewährte Methoden für Entwickler

          **Empfehlungen** für Programmierende:

• Fordern Sie die Überprüfung von Copilot in Ihrer IDE an, bevor Sie pushen, um Probleme frühzeitig zu erkennen und zu beheben.

• Hier können Copilot Sie Ihre eigenen PR-Rezensionskommentare planen und verfeinern, um PR-Autoren dabei zu helfen, Probleme zu verstehen und zu beheben.

• Fügen Sie relevanten Diff-Kontext, einschließlich bestimmter Codezeilen, Ihrer Unterhaltung mit Copilot hinzu.

          **Entwickler sollten nicht**:
  

• Wenden Sie die Vorschläge von Copilot ohne Test an.

• Verlassen Sie sich ausschließlich auf die Bewertungen von Copilot.

• Vernachlässige die Codelesbarkeit.

Ressourcen

•         [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot)
  

•         [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review?tool=vscode#reviewing-changes)
  

•         [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions)
  

•         [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review)
  

•         [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)
  

Zu überwachende Metriken

Um Testversionen neuer Tools zu bewerten und sicherzustellen, dass Ihre vollständigen Rollouts konsistente Verbesserungen bieten, überwachen Sie die Ergebnisse, und nehmen Sie bei Bedarf Anpassungen vor. Wir empfehlen, die wichtigsten Bereiche der Qualität, Geschwindigkeit und Entwicklerzufriedenheit zu berücksichtigen und wie diese Zonen zusammenkommen, um zu geschäftsergebnissen beizutragen.

Hier sind einige Metriken zur Bewertung der Auswirkungen von Copilot auf dieses spezielle Ziel.

•         **Zufriedenheit der Entwicklungsabteilung**: Führe Umfragen durch, um die Zufriedenheit mit Engineering-Tools zu messen.
  

•         **Pro Entwickler zusammengeführte Pull-Requests**: Mit dem `pull request`-Webhook kann sichergestellt werden, dass der `action`-Wert `closed` ist und die `merged`-Eigenschaft im `pull request`-Objekt den Wert `true` hat.
  

•         **Vorlaufzeit von Pull Requests**: Miss die durchschnittliche Zeitspanne zwischen dem Erstellen und Mergen von Pull Requests.
  

•         **Fehler-Entweichrate bei Pull Requests**: Messung der Rate der Bereitstellungsprobleme, die durch schlecht überprüfte Pull Requests verursacht werden.
  

•         **Kommentartyp für Pull-Request-Reviews**: Lade Kommentare zu PR-Reviews herunter, kategorisiere mithilfe der KI-basierten Themenklassifizierung und verfolge Kommentare von prüfenden Personen zu Entwurf, Skalierbarkeit und Strategie nach.