Configurare Copilot istruzioni per la revisione del codice

Servizi di Azure DevOps

Usare istruzioni personalizzate per personalizzare il comportamento di revisione del codice di Copilot a livello di organizzazione, progetto e repository. Guida alle istruzioni personalizzate Copilot concentrarsi su specifici standard di codifica, procedure consigliate o criteri dell'organizzazione.

Prerequisiti

Ambiti di istruzioni personalizzati

È possibile definire istruzioni personalizzate in più ambiti:

• Livello organizzazione: Standard di base che si applicano a tutti i progetti.
• Project livello: standard specifici del team o project.
• Livello repository: Standard specifici del repository in .github/copilot-instructions.md o .azuredevops/copilot-instructions.md.

Quando le istruzioni esistono in più ambiti, Copilot usa tutte le istruzioni applicabili durante la revisione.

Istruzioni personalizzate per l'organizzazione e il progetto

Configurare istruzioni personalizzate a livello di organizzazione e a livello di progetto nelle impostazioni di Azure DevOps. Usare questi ambiti per i criteri generali, ad esempio i requisiti di sicurezza, le regole di conformità o le convenzioni del linguaggio condivise da più repository.

File di istruzioni personalizzate del repository

Archiviare istruzioni personalizzate in .github/copilot-instructions.md o .azuredevops/copilot-instructions.md nella radice del repository. Copilot legge questo file durante ogni revisione per comprendere le linee guida specifiche del repository.

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

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

Creare istruzioni personalizzate

1. Nel repository creare una .github cartella o .azuredevops se non ne esiste già una.
2. Creare un nuovo file denominato copilot-instructions.md nella .github cartella o .azuredevops .
3. Aggiungere le istruzioni personalizzate in formato Markdown.
4. Eseguire il commit e il push del file nel repository.

Aggiungere istruzioni con ambito percorso

Usare i file di istruzioni con ambito percorso quando si desiderano regole diverse per cartelle, tipi di file o tecnologie specifiche.

• Creare uno o più *.instructions.md file in .github/instructions/ o .azuredevops/instructions/.
• Aggiungere il front matter YAML con un applyTo valore destinato ai file corrispondenti.
• Mantenere il materiale sussidiario incentrato su una lingua o un problema per ogni file.

Copilot applica regole con ambito percorso solo ai file modificati che corrispondono ai applyTo modelli.

Formato di file con ambito percorso

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

Esempi di pattern applyTo

• applyTo: "**" si applica a tutti i file.
• applyTo: "**/*.cs" si applica a tutti i file C#.
• applyTo: "**/*.sql,**/Settings.xml" si applica a più modelli.

Se un file con ambito percorso non include applyTo, Copilot ignora tale file.

Procedure consigliate per le istruzioni personalizzate

• Essere specifici: Fornire indicazioni chiare e utilizzabili per i tipi di problemi Copilot devono essere contrassegnate.
• Concentrarsi sulle aree ad alto impatto: Classificare in ordine di priorità la qualità del codice, la sicurezza e i problemi relativi alle prestazioni rilevanti per la codebase.
• Includere esempi: Se appropriato, fornire esempi di codice di problemi da cercare o modelli da evitare.
• Mantieni conciso: Copilot elabora l'intero file per ogni recensione, quindi essere diretto ed evitare spiegazioni dettagliate.
• Aggiornare regolarmente: Esaminare e aggiornare le istruzioni man mano che si evolvono gli standard di codifica.

Istruzioni personalizzate di esempio

# 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

Livello organizzazione

Aggiungere istruzioni personalizzate a livello di organizzazione per definire standard di revisione generali nell'intera azienda.

Le istruzioni a livello di organizzazione influiscono Copilot revisione del codice per tutti i progetti e tutti i repository in tale organizzazione, quindi usarle per i requisiti che ogni team deve seguire.

Livello progetto

Aggiungere istruzioni personalizzate a livello di progetto per definire gli standard di revisione condivisa in tutti i repository di progetti.

le istruzioni a livello di Project influenzano Copilot verifica del codice per tutti i repository in tale project, quindi usarle per le convenzioni che ogni team del project deve seguire.

Ordine di precedenza

Quando le istruzioni si sovrappongono, Copilot le applica in questo ordine di precedenza:

1. Istruzioni a livello di repository
2. istruzioni a livello di Project
3. Istruzioni a livello di organizzazione

Le istruzioni del repository hanno la precedenza più alta, seguite da istruzioni a livello di progetto e quindi istruzioni a livello di organizzazione.

Se due istruzioni sono in conflitto, Copilot usa l'istruzione con l'ambito di precedenza superiore.

Come ottenere assistenza

Per la risoluzione dei problemi relativi a istruzioni personalizzate e risposte alle domande frequenti su Copilot revisione del codice, vedere Risolvere i problemi Copilot revisione del codice.

Passo successivo

Contenuti correlati

• Risolvere i problemi relativi alla revisione del codice Copilot
• Introduzione alla revisione del codice Copilot
• Informazioni sulle istruzioni personalizzate per GitHub Copilot
• Esamina le pull request
• Configurare i criteri dei rami