Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
services Azure DevOps
Important
Cette fonctionnalité est en préversion limitée.
Certaines fonctionnalités peuvent ne pas encore être disponibles dans votre environnement, car Microsoft déploie des fonctionnalités d’évaluation en phases. Les fonctionnalités peuvent changer ou être supprimées sans préavis. Les fonctionnalités en préversion n’ont pas de contrat de niveau de service (SLA) et une prise en charge limitée.
Utilisez des instructions personnalisées pour adapter le comportement de révision du code de Copilot au niveau de l'organisation, du projet et du référentiel. Guide des instructions personnalisées Copilot pour vous concentrer sur des normes de codage, des bonnes pratiques ou des stratégies organisationnelles spécifiques.
Prerequisites
| Catégorie | Requirements |
|---|---|
| Activation des fonctionnalités | Copilot révision du code doit être activée au niveau de l’organisation, du projet et du référentiel. |
| Autorisations d’organisation | Project autorisations d’administrateur de collection pour ajouter ou modifier des instructions personnalisées au niveau de l’organisation. |
| autorisations de Project | Project autorisations d’administrateur pour ajouter ou modifier des instructions personnalisées de niveau project. |
| Autorisations du référentiel | Autorisations d’envoi (push) ou d’administrateur au référentiel pour ajouter ou modifier des instructions personnalisées au niveau du référentiel. |
Étendues d’instructions personnalisées
Vous pouvez définir des instructions personnalisées dans plusieurs étendues :
- Niveau de l’organisation : Normes de référence qui s’appliquent à tous les projets.
- Project niveau : normes spécifiques à l’équipe ou project.
-
Niveau du référentiel : Normes spécifiques au référentiel dans
.github/copilot-instructions.mdou.azuredevops/copilot-instructions.md.
Quand des instructions existent dans plusieurs étendues, Copilot utilise toutes les instructions applicables lors de la révision.
Note
Copilot lit les fichiers d'instructions au niveau du dépôt et de chemin d'accès uniquement à partir de la branche cible de la demande de tirage. Les modifications apportées aux fichiers d’instructions dans la demande de tirage n’affectent pas sa révision. Copilot utilise les modifications uniquement après leur fusion dans la branche cible.
Instructions personnalisées de l’organisation et du projet
Configurez les instructions personnalisées au niveau de l’organisation et au niveau du projet dans les paramètres Azure DevOps. Utilisez ces étendues pour les stratégies générales, telles que les exigences de sécurité, les règles de conformité ou les conventions linguistiques partagées par plusieurs référentiels.
Fichier d’instructions personnalisées du référentiel
Stockez des instructions personnalisées à .github/copilot-instructions.md.azuredevops/copilot-instructions.md la racine ou à la racine de votre référentiel. Copilot lit ce fichier pendant chaque révision pour comprendre les instructions spécifiques de votre référentiel.
.github/
copilot-instructions.md
instructions/
api.instructions.md
.azuredevops/ # same files work here too
copilot-instructions.md
instructions/
api.instructions.md
Créer des instructions personnalisées
- Dans votre référentiel, créez un ou
.azuredevopsun.githubdossier s’il n’en existe pas déjà. - Créez un fichier nommé
copilot-instructions.mddans le ou.azuredevopsle.githubdossier. - Ajoutez vos instructions personnalisées au format Markdown.
- Validez et transférez le fichier vers votre référentiel.
Ajouter des instructions délimitées au chemin d’accès
Utilisez des fichiers d’instructions délimités par le chemin lorsque vous souhaitez des règles différentes pour des dossiers, des types de fichiers ou des technologies spécifiques.
- Créez un ou plusieurs
*.instructions.mdfichiers dans l’une ou l’autre.github/instructions/ou.azuredevops/instructions/. - Ajoutez la matière frontale YAML avec une
applyTovaleur qui cible les fichiers correspondants. - Gardez les conseils axés sur une langue ou une préoccupation par fichier.
Copilot applique des règles délimitées au chemin d’accès uniquement aux fichiers modifiés qui correspondent aux applyTo modèles.
Format de fichier délimité par le chemin d’accès
---
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.
Exemples de modèles applyTo
-
applyTo: "**"s’applique à tous les fichiers. -
applyTo: "**/*.cs"s’applique à tous les fichiers C#. -
applyTo: "**/*.sql,**/Settings.xml"s’applique à plusieurs modèles.
Si un fichier délimité au chemin d'accès n'inclut applyTopas, Copilot ignore ce fichier.
Meilleures pratiques relatives aux instructions personnalisées
- Soyez spécifique : Fournissez des conseils clairs et exploitables pour les types de problèmes Copilot devez marquer.
- Concentrez-vous sur les domaines à fort impact : Hiérarchiser la qualité du code, la sécurité et les problèmes de performances pertinents pour votre codebase.
- Exemples d’exemples : Le cas échéant, fournissez des exemples de code de problèmes à rechercher ou à éviter.
- Gardez-le concis : Copilot traite l’intégralité du fichier pour chaque révision. Ainsi, soyez direct et évitez les explications détaillées.
- Mettez à jour régulièrement : Passez en revue et mettez à jour les instructions à mesure que vos normes de codage évoluent.
Exemples d’instructions personnalisées
# 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
Au niveau de l’organisation
Ajoutez des instructions personnalisées au niveau de l’organisation pour définir des normes d’examen étendues dans votre entreprise.
Les instructions au niveau de l’organisation influencent Copilot révision du code pour tous les projets et tous les référentiels de cette organisation, afin de les utiliser pour les exigences que chaque équipe doit suivre.
Au niveau du projet
Ajoutez des instructions personnalisées au niveau du projet pour définir des normes de révision partagée dans tous les référentiels de projet.
Project instructions au niveau du code influencent Copilot révision du code pour tous les référentiels de cette project. Utilisez-les donc pour les conventions que chaque équipe du project doit suivre.
Ordre de priorité
Lorsque les instructions se chevauchent, Copilot les applique dans cet ordre de priorité :
- Instructions au niveau du référentiel
- instructions de niveau Project
- Instructions au niveau de l’organisation
Les instructions de référentiel ont la priorité la plus élevée, suivie des instructions au niveau du projet, puis des instructions au niveau de l’organisation.
Si deux instructions sont en conflit, Copilot utilise l’instruction avec l’étendue de priorité supérieure.
Note
L'ordre de priorité des repères de priorité Copilot le comportement de révision, mais n'est pas garanti. Étant donné que Copilot utilise un modèle de langage volumineux, il peut parfois interpréter ou appliquer des instructions conflictuelles différemment.
Obtenir de l’aide
Pour résoudre les problèmes liés aux instructions personnalisées et aux réponses aux questions fréquemment posées sur Copilot révision du code, consultez Résoudre les problèmes Copilot révision du code.