Best Practices für die Verwendung von GitHub Copilot

Grundlegendes zu den Stärken und Schwächen von Copilot

GitHub Copilot ist ein KI-Codierungsassistent, der Ihnen hilft, Code schneller und mit weniger Aufwand zu schreiben, sodass Sie sich stärker auf Problemlösung und Zusammenarbeit konzentrieren können. Bevor Sie mit der Arbeit mit Copilot beginnen, ist es wichtig zu verstehen, wann Sie sie verwenden sollten und nicht verwenden sollten.

Einige der Dinge, die Copilot am besten kann, sind:

• Schreiben von Tests und sich wiederholendem Code
• Debuggen und Korrigieren der Syntax
• Erläutern und Kommentieren von Code
• Generieren regulärer Ausdrücke

Copilot ist an folgenden Stellen verfügbar:

• Reagieren auf Eingabeaufforderungen, die sich nicht auf Codierung und Technologie beziehen
• Ersetzen Sie Ihr Fachwissen und Ihre Fähigkeiten. Denken Sie daran, dass Sie verantwortlich sind und Copilot ein leistungsfähiges Tool in Ihrem Dienst ist.

Wählen Sie das richtige Copilot-Tool für den Job aus

Während Copilot-Codevervollständigungen und Copilot Chat einige Funktionen teilen, werden die beiden Tools unter unterschiedlichen Umständen am besten verwendet.

Codevervollständigungen funktionieren am besten für:

• Abschließen von Codeschnipseln, Variablennamen und Funktionen beim Schreiben
• Generieren von sich wiederholendem Code
• Generieren von Code aus in Inline-Kommentar in natürlicher Sprache
• Generieren von Tests für testgesteuerte Entwicklung

Alternativ eignet sich Copilot Chat am besten für:

• Beantworten von Fragen zum Code in natürlicher Sprache
• Generieren großer Codeabschnitte und anschließendes Durchlaufen dieses Codes, um Ihre Anforderungen zu erfüllen
• Ausführen bestimmter Aufgaben mit Schlüsselwörtern und Fähigkeiten. Copilot Chat verfügt über integrierte Schlüsselwörter und Fähigkeiten, die entwickelt wurden, um wichtige Kontexte für Eingabeaufforderungen bereitzustellen und häufige Aufgaben schnell auszuführen. Verschiedene Arten von Schlüsselwörtern und Fähigkeiten stehen auf unterschiedlichen Copilot Chat-Plattformen zur Verfügung. Weitere Informationen findest du unter Stellen von GitHub Copilot-Fragen in Ihrer IDE.
• Abschließen einer Aufgabe als bestimmte Persona. Sie können z. B. Copilot Chat mitteilen, dass es sich um einen erfahrenen C++-Entwickler handelt, der großen Wert auf Codequalität, Lesbarkeit und Effizienz legt, und ihn dann bitten, Ihren Code zu überprüfen.

Erstellen von durchdachten Eingabeaufforderungen

Prompt Engineering, d. h. die Strukturierung Ihrer Anforderung, damit Copilot sie leicht verstehen und beantworten kann, spielt eine entscheidende Rolle für die Fähigkeit von Copilot, eine wertvolle Antwort zu generieren. Hier sind einige schnelle Tipps, die Sie beim Erstellen Ihrer Eingabeaufforderungen beachten sollten:

• Aufschlüsseln von komplexen Aufgaben.
• Achten Sie auf Ihre Anforderungen.
• Stellen Sie Beispiele für Eingabedaten, Ausgaben und Implementierungen bereit.
• Befolgen Sie bewährte Programmiermethoden.

Weitere Informationen findest du unter Prompt Engineering für GitHub Copilot.

Überprüfen Sie die Arbeit von Copilot

Obwohl Copilot sehr leistungsfähig ist, ist es dennoch ein Tool, das Fehler machen kann, und Sie sollten den von ihm vorgeschlagenen Code immer validieren. Verwenden Sie die folgenden Tipps, um sicherzustellen, dass Sie genaue, sichere Vorschläge akzeptieren:

• Verstehen Sie den vorgeschlagenen Code, bevor Sie ihn implementieren. Um sicherzustellen, dass Sie den Vorschlag von Copilot vollständig verstehen, können Sie Copilot Chat bitten, den Code zu erklären.
• Prüfen Sie die Vorschläge von Copilot sorgfältig. Berücksichtigen Sie nicht nur die Funktionalität und Sicherheit des vorgeschlagenen Codes, sondern auch die Lesbarkeit und Wartbarkeit des Codes in der Zukunft.
• Verwenden Sie automatisierte Tests und Tools, um die Arbeit von Copilot zu überprüfen. Mit Hilfe von Tools wie Linting, code scanning und IP-Scanning können Sie eine zusätzliche Ebene von Sicherheits- und Genauigkeitsprüfungen automatisieren.

Führen Sie Copilot zu hilfreichen Ausgaben

Es gibt mehrere Anpassungen, die Sie vornehmen können, um Copilot auf wertvollere Antworten zu lenken:

• Versorgen Sie Copilot mit hilfreichem Kontext:
  • Wenn Sie Copilot in Ihrer IDE verwenden, öffnen Sie relevanten Dateien und schließen Sie nicht relevante Dateien.
  • In Copilot Chat wird eine bestimmte Anfrage aus der Konversation gelöscht, wenn der Kontext nicht mehr hilfreich ist. Wenn der Kontext einer bestimmten Unterhaltung nicht hilfreich ist, können Sie auch eine neue Unterhaltung beginnen.
  • Wenn Sie Copilot Chat in GitHub verwenden, geben Sie spezifische Repositorys, Dateien, Symbole und mehr als Kontext an. Weitere Informationen findest du unter Fragen zu GitHub Copilot in GitHub.com.
  • Wenn Sie Copilot Chat in Ihrer IDE verwenden, verwenden Sie Schlüsselwörter, um Copilot auf eine bestimmte Aufgabe oder einen bestimmten Kontext zu konzentrieren. Weitere Informationen findest du unter Stellen von GitHub Copilot-Fragen in Ihrer IDE.
• Schreiben Sie Ihre Eingabeaufforderungen neu, um unterschiedliche Antworten zu generieren. Wenn Copilot keine hilfreiche Antwort liefert, versuchen Sie, Ihre Eingabeaufforderung umzuformulieren oder Ihre Anforderung in mehrere kleinere Eingabeaufforderungen aufzuteilen.
• Wählen Sie den besten verfügbaren Vorschlag aus. Wenn Sie Codevervollständigungen verwenden, kann es sein, dass Copilot mehr als einen Vorschlag enthält. Sie können Tastaturkurzbefehle verwenden, um schnell alle verfügbaren Vorschläge zu durchsuchen. Die Standardtastenkombinationen für dein Betriebssystem findest du unter Konfigurieren von GitHub Copilot in deiner Umgebung.
• Geben Sie Feedback, um zukünftige Vorschläge zu verbessern. Sie können auf viele Arten Feedback geben:
  • Für die Vervollständigung des Codes akzeptieren oder verwerfen Sie den Vorschlag von Copilot.
  • Für einzelne Antworten in Copilot Chat klicken Sie auf die Daumen-hoch- oder Daumen-runter-Symbole neben der Antwort.
  • Für Copilot Chat in deiner IDE findest du unter Stellen von GitHub Copilot-Fragen in Ihrer IDE Anweisungen, die speziell für deine Umgebung gelten.
  • Für Copilot Chat in GitHub, hinterlassen Sie einen Kommentar in der Feedback-Diskussion.

Bleiben Sie auf dem Laufenden über die Features von Copilot

Es werden regelmäßig neue Features zu Copilot hinzugefügt, um neue Möglichkeiten zu schaffen, auf bestehenden Features aufzubauen und das Benutzererlebnis zu verbessern. Um über die Features von Copilot auf dem Laufenden zu bleiben, lesen Sie das Änderungsprotokoll.