Konfigurieren von Programmierrichtlinien für den GitHub Copilot-Review

Hier erfährst du, wie du den Copilot Code Review mit benutzerdefinierten Programmierrichtlinien anpasst.

In diesem Artikel

Hinweis

Das Feature für benutzerdefinierte Programmierrichtlinien ist nur für den Copilot Enterprise-Plan verfügbar und derzeit auf ausgewählte Kunden beschränkt.

Dieses Feature wird zugunsten der Verwendung von benutzerdefinierten Copilot-Anweisungen zum Anpassen von Copilot Code Review nicht mehr unterstützt. Weitere Informationen findest du unter Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot.

Informationen zu Programmierrichtlinien

Du kannst Copilot mit einer Reihe von Codierungsrichtlinien bereitstellen, die in natürlicher Sprache geschrieben sind, damit dein Code auf eine Weise überprüft wird, die dem Codierungsstil und den bewährten Methoden deiner Organisation entspricht. Weitere Informationen – einschließlich Beispiele für Codierungsrichtlinien – findest du unter Informationen zu Programmierrichtlinien für den GitHub Copilot-Review.

Erstellen einer Programmierrichtlinie

  1. Klicke im Abschnitt „Code & automation“ der Randleiste auf Copilot und dann auf Code review.

  2. Klicke auf Create guideline.

  3. Gib unter „Name“ den Namen der Programmierrichtlinie ein.

  4. Gib unter „Description“ eine Beschreibung der Programmierrichtlinie.Diese darf bis zu 600 Zeichen umfassen. Anhand der Beschreibung erfasst Copilot deinen Programmierstil und entscheidet, wann ein Kommentar hinterlassen werden soll.

    Wie du die Beschreibung schreibst, hat großen Einfluss auf die Qualität der Kommentare, die Copilot generiert. Hilfe zum Schreiben effektiver Codierungsrichtlinien findest du unter Informationen zu Programmierrichtlinien für den GitHub Copilot-Review.

  5. Beschränke die Programmierrichtlinie optional auf bestimmte Dateitypen oder Pfade, indem du auf Add file path klickst und Pfadmuster hinzufügst.

    Mithilfe der fnmatch-Syntax kannst du Zielpfade definieren, wobei * als Platzhalter fungiert, der mit einer beliebigen Zeichenfolge übereinstimmen kann.

    Da GitHub das Flag File::FNM_PATHNAME für die Syntax File.fnmatch verwendet, entspricht das Platzhalterzeichen * nicht den Verzeichnistrennzeichen (/). qa/* entspricht z. B. allen Branches, die mit qa/ beginnen und einen einzelnen Schrägstrich enthalten, aber nicht qa/foo/bar. Nach qa kann mit qa/**/* eine beliebige Anzahl von Schrägstrichen eingeschlossen werden, um z. B. qa/foo/bar/foobar/hello-world zu entsprechen. Du kannst mit qa**/**/* auch die Zeichenfolge qa erweitern, um die Regel auszudehnen.

    Weitere Informationen zu Syntaxoptionen findest du in der Dokumentation zu fnmatch.

  6. Teste deine Programmierrichtlinie, um sicherzustellen, dass sie erwartungsgemäß funktioniert.

    1. Klicke auf Add sample.
    2. Füge dein eigenes Beispiel hinzu, oder drücke Generate code sample, um basierend auf deinem Titel und deiner Beschreibung automatisch einen Beispielcode zu generieren.
    3. Klicke auf Save, um den Beispielcode zu speichern.
    4. Teste die Programmierrichtlinie für dein Beispiel, indem du Run drückst.

  7. Speichere deine Programmierrichtlinie, und aktiviere sie, indem du auf Save guideline klickst.