Instructies voor het controleren van Copilot code configureren

Azure DevOps Services

Gebruik aangepaste instructies om het gedrag van de codebeoordeling van Copilot op organisatie-, project- en opslagplaatsniveau aan te passen. Handleiding voor aangepaste instructies Copilot om te focussen op specifieke coderingsstandaarden, best practices of organisatiebeleid.

Prerequisites

Aangepaste instructiebereiken

U kunt aangepaste instructies definiëren voor meerdere bereiken:

• Organisatieniveau: Basislijnstandaarden die van toepassing zijn op alle projecten.
• Project niveau: Team- of project-specifieke standaarden.
• Niveau van opslagplaats: Opslagplaatsspecifieke standaarden in .github/copilot-instructions.md of .azuredevops/copilot-instructions.md.

Wanneer er instructies bestaan in meerdere bereiken, gebruikt Copilot alle toepasselijke instructies tijdens het controleren.

Aangepaste instructies voor organisatie en project

Configureer aangepaste instructies op organisatie- en projectniveau in Azure DevOps instellingen. Gebruik deze bereiken voor brede beleidsregels, zoals beveiligingsvereisten, nalevingsregels of taalconventies die worden gedeeld door meerdere opslagplaatsen.

Bestand met aangepaste instructies voor opslagplaats

Sla aangepaste instructies op in .github/copilot-instructions.md de .azuredevops/copilot-instructions.md hoofdmap van uw opslagplaats. Copilot leest dit bestand tijdens elke beoordeling om inzicht te hebben in de specifieke richtlijnen van uw opslagplaats.

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

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

Aangepaste instructies maken

1. Maak in uw opslagplaats een .github of .azuredevops map als deze nog niet bestaat.
2. Maak een nieuw bestand met de naam copilot-instructions.md in de .github of .azuredevops map.
3. Voeg uw aangepaste instructies toe in markdown-indeling.
4. Voer het bestand door en push het naar uw opslagplaats.

Instructies voor padbereik toevoegen

Gebruik pad-scoped instructiebestanden wanneer u verschillende regels wilt voor specifieke mappen, bestandstypen of technologieën.

• Maak een of meer *.instructions.md bestanden in .github/instructions/ of .azuredevops/instructions/.
• Voeg YAML-front-matter toe met een applyTo waarde die overeenkomt met bestanden.
• Houd richtlijnen gericht op één taal of probleem per bestand.

Copilot past regels met padbereik alleen toe op gewijzigde bestanden die overeenkomen met de applyTo patronen.

Bestandsindeling met padbereik

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

• applyTo: "**" is van toepassing op alle bestanden.
• applyTo: "**/*.cs" is van toepassing op alle C#-bestanden.
• applyTo: "**/*.sql,**/Settings.xml" is van toepassing op meerdere patronen.

Als een padbereikbestand niet bevatapplyTo, Copilot dat bestand overslaat.

Aanbevolen procedures voor aangepaste instructies

• Wees specifiek: Geef duidelijke, bruikbare richtlijnen voor de typen problemen die Copilot moet markeren.
• Focus op gebieden met een hoge impact: Prioriteit geven aan codekwaliteit, beveiliging en prestatieproblemen die relevant zijn voor uw codebasis.
• Voorbeelden zijn: Geef, indien van toepassing, codevoorbeelden op van problemen om te zoeken naar of patronen die moeten worden vermeden.
• Houd het beknopt: Copilot verwerkt het hele bestand voor elke beoordeling, dus wees direct en vermijd uitgebreide uitleg.
• Regelmatig bijwerken: Bekijk en werk de instructies bij naarmate uw coderingsstandaarden zich ontwikkelen.

Voorbeeld van aangepaste instructies

# 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

Organisatieniveau

Voeg aangepaste instructies toe op organisatieniveau om algemene beoordelingsstandaarden in uw onderneming te definiëren.

Instructies op organisatieniveau beïnvloeden Copilot codebeoordeling voor alle projecten en alle opslagplaatsen in die organisatie, dus gebruik deze voor vereisten die elk team moet volgen.

Projectniveau

Voeg aangepaste instructies toe op projectniveau om standaarden voor gedeelde beoordeling in alle projectopslagplaatsen te definiëren.

Project instructies beïnvloeden Copilot codebeoordeling voor alle opslagplaatsen in die project, dus gebruik deze voor conventies die elk team in de project moet volgen.

Volgorde van prioriteit

Wanneer de instructies elkaar overlappen, Copilot deze in deze volgorde van prioriteit toe te passen:

1. Instructies op opslagplaatsniveau
2. instructies op Project niveau
3. Instructies op organisatieniveau

Opslagplaatsinstructies hebben de hoogste prioriteit, gevolgd door instructies op projectniveau en vervolgens instructies op organisatieniveau.

Als er twee instructies conflicteren, gebruikt Copilot de instructie met het bereik met een hogere prioriteit.

Hulp krijgen

Zie Problemen met Copilot codebeoordeling oplossen voor meer informatie over het oplossen van aangepaste instructies en antwoorden op veelgestelde vragen over Copilot codebeoordeling.

Volgende stap

Verwante onderwerpen

• Problemen met Copilot codebeoordeling oplossen
• Aan de slag met Copilot codebeoordeling
• Over aangepaste instructies voor GitHub Copilot
• pull-aanvragen controleren
• Vertakkingsbeleid configureren