Konfigurera Copilot kodgranskningsinstruktioner

Azure DevOps-tjänster

Important

Den här funktionen är i offentlig förhandsversion.

Använd anpassade instruktioner för att skräddarsy Copilots kodgranskningsbeteende på organisations-, projekt- och arkivnivå. Anpassade instruktioner vägleder Copilot att fokusera på specifika kodningsstandarder, metodtips eller organisationsprinciper.

Förutsättningar

Kategori Requirements
Aktivering av funktioner Copilot kodgranskning måste aktiveras på organisations-, projekt- och reponivå.
Organisationsbehörigheter Behörighet som administratör för projektsamling för att lägga till eller ändra anpassade instruktioner på organisationsnivå.
Projektbehörigheter behörigheter för projektadministratör för att lägga till eller ändra anpassade instruktioner på projektnivå.
Lagringsplatsbehörigheter Du behöver push- eller administratörsbehörighet till repot för att lägga till eller ändra anpassade instruktioner på reponivå.

Anpassade instruktionsområden

Du kan definiera anpassade instruktioner i flera omfång:

  • Organisationsnivå: Baslinjestandarder som gäller för alla projekt.
  • Projektnivå: Team- eller projektspecifika standarder.
  • Reponivå: Repospecifika standarder i .github/copilot-instructions.md eller .azuredevops/copilot-instructions.md.

När instruktioner finns på flera nivåer använder Copilot alla tillämpliga instruktioner under granskningen.

Note

Copilot läser instruktionsfiler på lagringsplatsnivå och sökvägsbegränsade instruktionsfiler endast från pull requestens målgren. Ändringar i konfigurationsfiler i pull-begäran påverkar inte granskningen. Copilot använder ändringarna först när de har sammanfogats till målgrenen.

Anpassade anvisningar för organisation och projekt

Konfigurera anpassade instruktioner på organisationsnivå och projektnivå i Azure DevOps inställningar. Använd dessa scope för övergripande policyer, till exempel säkerhetskrav, efterlevnadsregler eller språkkonventioner som delas av flera repositorier.

Fil med anpassade instruktioner för repository

Lagra anpassade instruktioner i antingen .github/copilot-instructions.md eller .azuredevops/copilot-instructions.md i roten på repot. Copilot läser den här filen under varje granskning för att förstå repots specifika riktlinjer.

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

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

Skapa anpassade instruktioner

  1. I ditt repository, skapa en .github eller .azuredevops-mapp om den inte redan finns.
  2. Skapa en ny fil med namnet copilot-instructions.md i mappen .github eller .azuredevops-mappen.
  3. Lägg till dina anpassade instruktioner i Markdown-format.
  4. Checka in och pusha filen till ditt repository.

Lägg till instruktioner för sökvägsomfång

Använd instruktionsfiler med sökvägsomfång när du vill ha olika regler för specifika mappar, filtyper eller tekniker.

  • Skapa en eller flera *.instructions.md filer i antingen .github/instructions/ eller .azuredevops/instructions/.
  • Lägg till YAML-inledande metadata med ett applyTo-värde som riktar sig mot matchande filer.
  • Håll vägledningen fokuserad på ett språk eller problem per fil.

Copilot tillämpar regler med sökvägsomfång endast på ändrade filer som matchar applyTo mönstren.

Sökvägsbegränsat filformat

---
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.

exempel på applyTo-mönster

  • applyTo: "**" gäller för alla filer.
  • applyTo: "**/*.cs" gäller för alla C#-filer.
  • applyTo: "**/*.sql,**/Settings.xml" gäller för flera mönster.

Om en fil med sökvägsomfång inte innehåller applyTo, hoppar Copilot över filen.

Bästa praxis för anpassade instruktioner

  • Var specifik: Ge tydlig och användbar vägledning för de typer av problem som Copilot ska flagga.
  • Fokus på områden med hög påverkan: Prioritera frågor om kodkvalitet, säkerhet och prestanda som är relevanta för din kodbas.
  • Ta med exempel: När det är lämpligt anger du kodexempel på problem att söka efter eller mönster att undvika.
  • Behåll det kortfattat: Copilot bearbetar hela filen för varje granskning, så var direkt och undvik utförliga förklaringar.
  • Uppdatera regelbundet: Granska och uppdatera anvisningarna när kodningsstandarderna utvecklas.

Exempel på anpassade instruktioner

# 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

Organisationsnivå

Lägg till anpassade instruktioner på organisationsnivå för att definiera breda granskningsstandarder i hela företaget.

Instruktioner på organisationsnivå påverkar Copilot kodgranskning för alla projekt och alla repositorier i organisationen, så använd dem för krav som varje team bör följa.

Skärmbild av konfiguration av anpassade instruktioner på organisationsnivå som visar inställningar som gäller för alla projekt och repositorier i en organisation.

Projektnivå

Lägg till anpassade instruktioner på projektnivå för att definiera gemensamma granskningsstandarder i alla projektrepositorier.

Instruktioner på projektnivå påverkar Copilots kodgranskning för alla kodförråd i projektet, så använd dem för konventioner som varje team i projektet ska följa.

Skärmbild av konfiguration av anpassade instruktioner på projektnivå som visar inställningar som gäller för alla repositorier i ett projekt.

Prioritetsordning

När anvisningarna överlappar varandra tillämpar Copilot dem i den här prioritetsordningen:

  1. Instruktioner på reponivå
  2. instruktioner på projektnivå
  3. Instruktioner på organisationsnivå

Repository-anvisningar har högsta prioritet, följt av instruktioner på projektnivå och sedan instruktioner på organisationsnivå.

Om två instruktioner är i konflikt använder Copilot instruktionen med det högre prioriterade omfånget.

Note

Prioritetsordningen vägleder Copilots granskningsbeteende, men detta garanteras inte. Eftersom Copilot använder en stor språkmodell kan den ibland tolka eller tillämpa motstridiga instruktioner på olika sätt.

Få hjälp

För felsökning av anpassade instruktioner och svar på vanliga frågor om Copilot kodgranskning, se Felsöka Copilot kodgranskning.

Nästa steg