Configurar instruções de revisão de código Copilot

Serviços do Azure DevOps

Use instruções personalizadas para adaptar o comportamento de revisão de código do Copilot nos níveis de organização, projeto e repositório. Guia de instruções personalizadas Copilot se concentrar em padrões de codificação específicos, práticas recomendadas ou políticas organizacionais.

Pré-requisitos

Escopos de instrução personalizados

Você pode definir instruções personalizadas em vários escopos:

• Nível da organização: Padrões de linha de base que se aplicam em todos os projetos.
• Project nível: padrões específicos de equipe ou project.
• Nível do repositório: Padrões específicos do repositório em .github/copilot-instructions.md ou .azuredevops/copilot-instructions.md.

Quando há instruções em vários escopos, Copilot usa todas as instruções aplicáveis durante a revisão.

Instruções personalizadas de organização e projeto

Configure instruções personalizadas no nível da organização e no nível do projeto nas configurações de Azure DevOps. Use esses escopos para políticas amplas, como requisitos de segurança, regras de conformidade ou convenções de idioma compartilhadas por vários repositórios.

Arquivo de instruções personalizadas do repositório

Armazene instruções personalizadas na .github/copilot-instructions.md raiz ou .azuredevops/copilot-instructions.md na raiz do repositório. Copilot lê esse arquivo durante cada revisão para entender as diretrizes específicas do repositório.

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

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

Criar instruções personalizadas

1. No repositório, crie uma .github ou .azuredevops pasta se ainda não existir.
2. Crie um novo arquivo nomeado copilot-instructions.md na pasta ou .azuredevops na .github pasta.
3. Adicione suas instruções personalizadas no formato Markdown.
4. Confirme e efetue push do arquivo para o repositório.

Adicionar instruções com escopo de caminho

Use arquivos de instrução com escopo de caminho quando desejar regras diferentes para pastas específicas, tipos de arquivo ou tecnologias.

• Criar um ou mais arquivos em um .github/instructions/ ou .azuredevops/instructions/mais*.instructions.md.
• Adicione matéria frontal YAML com um applyTo valor direcionado a arquivos correspondentes.
• Mantenha as diretrizes focadas em um idioma ou preocupação por arquivo.

Copilot aplica regras com escopo de caminho somente a arquivos alterados que correspondem aos applyTo padrões.

Formato de arquivo com escopo de caminho

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

exemplos de padrão applyTo

• applyTo: "**" aplica-se a todos os arquivos.
• applyTo: "**/*.cs" aplica-se a todos os arquivos C#.
• applyTo: "**/*.sql,**/Settings.xml" aplica-se a vários padrões.

Se um arquivo com escopo de caminho não incluirapplyTo, Copilot ignorará esse arquivo.

Práticas recomendadas de instruções personalizadas

• Seja específico: Forneça diretrizes claras e acionáveis para os tipos de problemas que Copilot devem sinalizar.
• Concentre-se em áreas de alto impacto: Priorize as preocupações de qualidade, segurança e desempenho de código relevantes para sua base de código.
• Inclua exemplos: Quando apropriado, forneça exemplos de código de problemas para procurar ou padrões a serem evitados.
• Mantenha-o conciso: Copilot processa todo o arquivo para cada revisão, portanto, seja direto e evite explicações detalhadas.
• Atualize regularmente: Examine e atualize as instruções à medida que seus padrões de codificação evoluem.

Exemplo de instruções personalizadas

# 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

Nível da organização

Adicione instruções personalizadas no nível da organização para definir padrões de revisão amplos em toda a sua empresa.

As instruções no nível da organização influenciam Copilot revisão de código para todos os projetos e todos os repositórios dessa organização, portanto, use-os para os requisitos que todas as equipes devem seguir.

Nível do projeto

Adicione instruções personalizadas no nível do projeto para definir padrões de revisão compartilhada em todos os repositórios de projeto.

Project instruções de nível influenciam Copilot revisão de código para todos os repositórios nesse project, portanto, use-os para convenções que todas as equipes do project devem seguir.

Ordem de precedência

Quando as instruções se sobrepõem, Copilot as aplica nesta ordem de precedência:

1. Instruções no nível do repositório
2. instruções de nível Project
3. Instruções no nível da organização

As instruções do repositório têm a precedência mais alta, seguidas por instruções no nível do projeto e, em seguida, instruções no nível da organização.

Se duas instruções entrarem em conflito, Copilot usará a instrução com o escopo de precedência superior.

Obter ajuda

Para solucionar problemas de instruções e respostas personalizadas para perguntas frequentes sobre Copilot revisão de código, consulte Solucionar problemas Copilot revisão de código.

Próximas etapas

Conteúdo relacionado

• Solucionar problemas Copilot revisão de código
• Introdução à revisão de código Copilot
• Sobre instruções personalizadas para GitHub Copilot
• Analisar as solicitações de pull
• Configurar políticas de ramificação