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 den Copilot Code Review mit benutzerdefinierten Programmierrichtlinien in natürlicher Sprache anpassen. Weitere Informationen zum Copilot Code Review findest du unter Informationen zu Code Reviews mit Copilot.
Mit Programmierrichtlinien kann Copilot basierend auf dem individuellen Programmierstil und den Best Practices deiner Organisation Feedback geben.
Da der Copilot Code Review auf einem Large Language Model beruht, kann er helfen, Programmierrichtlinien zu erzwingen, die nicht von deinem Linter- oder statischen Analysetool abgedeckt werden.
Programmierrichtlinien werden auf Repositoryebene konfiguriert. Du kannst bis zu sechs Programmierrichtlinien pro Repository erstellen und aktivieren. Weitere Informationen findest du unter Konfigurieren von Programmierrichtlinien für den GitHub Copilot-Review.
Wenn du einen Review von Copilot anforderst, verwendet Copilot automatisch die für das Repository aktivierten Programmierrichtlinien, um deinen Code zu prüfen.
Auf einer Programmierrichtlinie basierende Kommentare enthalten eine Nachricht, in der die Quelle hervorgehoben wird.
Hinweis
Programmierrichtlinien gelten nur für Reviews, die von Copilot durchgeführt werden. Die Richtlinien haben keine Auswirkungen auf die Copilot-Vorschläge zur Codevervollständigung oder Code, der in Copilot Chat-Antworten vorgeschlagen wird.
Empfehlungen für Programmierrichtlinien
- Verwende einfache, klare und präzise Sprache, um deine Programmierrichtlinie zu beschreiben.
- Beschreibe so konkret wie möglich, wonach Copilot suchen soll, d. h., was dein Code enthalten soll und was nicht.
- Prüfe die Beispiele für Programmierrichtlinien weiter unten, um dich inspirieren zu lassen.
- Versuche nicht, mithilfe von Programmierrichtlinien Stilrichtlinien zu erzwingen, die von deinem Linter- oder statischen Analysetool abgedeckt werden können.
- Verwende keine Wörter, die mehrdeutig sind oder auf unterschiedliche Weise interpretiert werden können.
- Versuche nicht, mehrere verschiedene Ideen in einer einzigen Programmierrichtlinie zusammenzufassen.
Beispiele für Programmierrichtlinien
Beispiel 1: Vermeiden von magischen Zahlen
Titel: Avoid using magic numbers
Beschreibung: Don't use magic numbers in code. Numbers should be defined as constants or variables with meaningful names.
Pfadmuster: **/*.py
Beispiel 2: Vermeiden von SELECT * in SQL-Abfragen
Titel: Don't use `SELECT *` in SQL queries
Beschreibung: Don't use `SELECT *` in SQL queries. Always specify the columns you want to select. `COUNT(*)` is allowed.
Pfadmuster: Keines (gilt für alle Dateitypen, da SQL-Abfragen unter Umständen in Code eingebettet werden)
Beispiel 3: Verwenden von fetch für HTTP-Anforderungen
Titel: Use `fetch` for HTTP requests
Beschreibung: Use `fetch` for HTTP requests, not `axios` or `superagent` or other libraries.
Pfadmuster: **/*.ts, **/*.js, **/*.jsx, **/*.tsx
Beispiel 4: Ständiges Taggen von Metriken mit der aktuellen Umgebung
Titel: Always tag metrics with the current environment
Beschreibung: Always include a `env` tag with the current environment when emitting metrics, for example, `env:prod` or `env:dev`.
Pfadmuster: */*.go, */*.java