Konfigurera Copilot kodgranskningsinstruktioner

Azure DevOps-tjänster

Använd anpassade instruktioner för att skräddarsy Copilot kodgranskningsbeteende på organisations-, projekt- och lagringsplatsnivå. Guide för anpassade instruktioner Copilot för att fokusera på specifika kodningsstandarder, metodtips eller organisationsprinciper.

Förutsättningar

Anpassade instruktionsomfång

Du kan definiera anpassade instruktioner i flera omfång:

• Organisationsnivå: Baslinjestandarder som gäller för alla projekt.
• Project nivå: Team- eller project-specifika standarder.
• Lagringsplatsnivå: Lagringsplatsspecifika standarder i .github/copilot-instructions.md eller .azuredevops/copilot-instructions.md.

När instruktioner finns i flera omfång använder Copilot alla tillämpliga instruktioner under granskningen.

Anpassade anvisningar för organisation och projekt

Konfigurera anpassade instruktioner på organisationsnivå och projektnivå i Azure DevOps inställningar. Använd dessa omfång för breda principer, till exempel säkerhetskrav, efterlevnadsregler eller språkkonventioner som delas av flera lagringsplatser.

Fil med anpassade instruktioner för lagringsplats

Lagra anpassade instruktioner i antingen .github/copilot-instructions.md eller .azuredevops/copilot-instructions.md i roten på lagringsplatsen. Copilot läser den här filen under varje granskning för att förstå lagringsplatsens 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. Skapa en .github eller .azuredevops mapp på lagringsplatsen om den inte redan finns.
2. Skapa en ny fil med namnet copilot-instructions.md i .github mappen eller .azuredevops .
3. Lägg till dina anpassade instruktioner i Markdown-format.
4. Checka in och skicka filen till lagringsplatsen.

Lägga till sökvägsomfångsinstruktioner

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-frontmaterial 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 sökvägsomfångsregler endast på ändrade filer som matchar mönstrenapplyTo.

Filformat med sökvägsomfång

---
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-mönsterexempel

• 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 sökvägsomfångsfil inte innehåller applyTohoppar Copilot över filen.

Metodtips 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 lagringsplatser i organisationen, så använd dem för krav som varje team bör följa.

Projektnivå

Lägg till anpassade instruktioner på projektnivå för att definiera standarder för delad granskning i alla projektlagringsplatser.

Project-nivåinstruktioner påverkar Copilot kodgranskning för alla lagringsplatser i den project, så använd dem för konventioner som varje team i project ska följa.

Prioritetsordning

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

1. Instruktioner på lagringsplatsnivå
2. instruktioner på Project nivå
3. Instruktioner på organisationsnivå

Lagringsanvisningar 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 omfånget högre prioritet.

Få hjälp

Felsökning av anpassade instruktioner och svar på vanliga frågor om Copilot kodgranskning finns i Felsöka Copilot kodgranskning.

Nästa steg

Relaterat innehåll

• Felsöka Copilot kodgranskning
• Kom igång med Copilot kodgranskning
• Om anpassade instruktioner för GitHub Copilot
• Granska pull-begäranden
• Konfigurera grenprinciper