Konfigurieren Copilot Codeüberprüfungsanweisungen

Azure DevOps Services

Verwenden Sie benutzerdefinierte Anweisungen, um das Verhalten der Codeüberprüfung Copilot auf Organisations-, Projekt- und Repositoryebenen anzupassen. Benutzerdefinierte Anleitungen Copilot, um sich auf bestimmte Codierungsstandards, bewährte Methoden oder Organisationsrichtlinien zu konzentrieren.

Voraussetzungen

Benutzerdefinierte Anweisungsbereiche

Sie können benutzerdefinierte Anweisungen in mehreren Bereichen definieren:

• Organisationsebene: Basisstandards, die für alle Projekte gelten.
• Project Ebene: Team- oder project spezifische Standards.
• Repositoryebene: Repositoryspezifische Standards in .github/copilot-instructions.md oder .azuredevops/copilot-instructions.md.

Wenn Anweisungen in mehreren Bereichen vorhanden sind, verwendet Copilot während der Überprüfung alle anwendbaren Anweisungen.

Benutzerdefinierte Anweisungen für Organisation und Projekt

Konfigurieren Sie benutzerdefinierte Anweisungen auf Organisationsebene und auf Projektebene in Azure DevOps Einstellungen. Verwenden Sie diese Bereiche für allgemeine Richtlinien, z. B. Sicherheitsanforderungen, Complianceregeln oder Sprachkonventionen, die von mehreren Repositorys gemeinsam genutzt werden.

Benutzerdefinierte Datei für Repositoryanweisungen

Speichern Sie benutzerdefinierte Anweisungen entweder im .github/copilot-instructions.md.azuredevops/copilot-instructions.md Stammverzeichnis Ihres Repositorys. Copilot liest diese Datei während jeder Überprüfung, um die spezifischen Richtlinien Ihres Repositorys zu verstehen.

.github/
   copilot-instructions.md
   instructions/
      api.instructions.md

.azuredevops/                       # same files work here too
   copilot-instructions.md
   instructions/
      api.instructions.md

Erstellen benutzerdefinierter Anweisungen

1. Erstellen Sie in Ihrem Repository einen .github oder .azuredevops einen Ordner, falls noch kein Ordner vorhanden ist.
2. Erstellen Sie eine neue Datei, die .github im Ordner oder .azuredevops im Ordner benannt istcopilot-instructions.md.
3. Fügen Sie Ihre benutzerdefinierten Anweisungen im Markdown-Format hinzu.
4. Committe die Datei, und pushe sie in dein Repository.

Hinzufügen von Pfadbereichsanweisungen

Verwenden Sie Pfadbezogene Anweisungsdateien, wenn Sie unterschiedliche Regeln für bestimmte Ordner, Dateitypen oder Technologien verwenden möchten.

• Erstellen Sie eine oder mehrere Dateien in einer .github/instructions/ oder *.instructions.md.azuredevops/instructions/mehreren Dateien.
• Fügen Sie YAML-Front-Matter mit einem applyTo Wert hinzu, der auf übereinstimmende Dateien ausgerichtet ist.
• Halten Sie Die Anleitungen auf eine Sprache oder ein Problem pro Datei konzentriert.

Copilot wendet Pfadbereichsregeln nur auf geänderte Dateien an, die den applyTo Mustern entsprechen.

Pfadbezogenes Dateiformat

---
applyTo: "**/*.ts,**/*.tsx"
---

## TypeScript standards

- Avoid `any`; prefer `unknown` or a specific type.
- Prefer `const`; avoid `var`.
- Use optional chaining (`?.`) and nullish coalescing (`??`) where appropriate.

applyTo-Musterbeispiele

• applyTo: "**" gilt für alle Dateien.
• applyTo: "**/*.cs" gilt für alle C#-Dateien.
• applyTo: "**/*.sql,**/Settings.xml" gilt für mehrere Muster.

Wenn eine pfadbezogene Datei nicht enthalten applyToist, überspringt Copilot diese Datei.

Bewährte Methoden für benutzerdefinierte Anweisungen

• Seien Sie spezifisch: Stellen Sie klare, umsetzbare Anleitungen für die Arten von Problemen bereit, die Copilot kennzeichnen sollten.
• Konzentrieren Sie sich auf bereiche mit hohem Einfluss: Priorisieren Sie Codequalität, Sicherheit und Leistung, die für Ihre Codebasis relevant sind.
• Beispiele einschließen: Stellen Sie ggf. Codebeispiele für Probleme bereit, nach denen gesucht werden soll, oder Muster, die vermieden werden sollen.
• Halten Sie es prägnant: Copilot verarbeitet die gesamte Datei für jede Überprüfung, also seien Sie direkt und vermeiden Ausführliche Erklärungen.
• Regelmäßig aktualisieren: Überprüfen und aktualisieren Sie Anweisungen, während Sich Ihre Codierungsstandards entwickeln.

Beispiel für benutzerdefinierte Anweisungen

# Copilot code review instructions

## Security focus
- Flag any hardcoded credentials, API keys, or sensitive data
- Identify potential SQL injection or XSS vulnerabilities
- Check for secure use of cryptographic functions

## Performance considerations
- Suggest database query optimizations
- Identify N+1 query problems
- Flag inefficient loops or algorithms

## Team coding standards
- Enforce naming conventions (camelCase for variables, PascalCase for classes)
- Check for proper error handling and logging
- Ensure consistent use of async/await patterns

## Documentation requirements
- Flag missing or incomplete function documentation
- Verify that complex logic includes explanatory comments

Organisationsebene

Fügen Sie benutzerdefinierte Anweisungen auf Organisationsebene hinzu, um umfassende Überprüfungsstandards in Ihrem Unternehmen zu definieren.

Anweisungen auf Organisationsebene beeinflussen Copilot Codeüberprüfung für alle Projekte und alle Repositorys in dieser Organisation. Verwenden Sie sie daher für Anforderungen, die jedes Team befolgen sollte.

Projektebene

Fügen Sie benutzerdefinierte Anweisungen auf Projektebene hinzu, um gemeinsame Überprüfungsstandards für alle Projektrepositorys zu definieren.

Project-Level-Anweisungen beeinflussen Copilot Codeüberprüfung für alle Repositorys in diesem project. Verwenden Sie sie daher für Konventionen, die jedes Team in der project befolgen sollte.

Rangfolge

Wenn sich Anweisungen überschneiden, wendet Copilot sie in dieser Reihenfolge der Rangfolge an:

1. Anweisungen auf Repositoryebene
2. Anweisungen auf Project Ebene
3. Anweisungen auf Organisationsebene

Repositoryanweisungen haben die höchste Priorität, gefolgt von Anweisungen auf Projektebene und dann Anweisungen auf Organisationsebene.

Wenn zwei Anweisungen in Konflikt geraten, verwendet Copilot die Anweisung mit dem Bereich höherer Rangfolge.

Hilfe erhalten

Informationen zur Problembehandlung bei benutzerdefinierten Anweisungen und Antworten auf häufig gestellte Fragen zu Copilot Codeüberprüfung finden Sie unter Problembehandlung Copilot Codeüberprüfung.

Nächster Schritt

Verwandte Inhalte

• Problembehandlung bei Copilot Codeüberprüfung
• Erste Schritte mit Copilot Codeüberprüfung
• Informationen zu benutzerdefinierten Anweisungen für GitHub Copilot
• Übersicht zu Pull Requests
• Konfigurieren Sie die Branch Policies