Como adicionar instruções personalizadas de repositório no GitHub Copilot

Além disso, você pode criar arquivos de prompt. Com arquivos de prompt, você pode especificar instruções de prompt comuns e contexto relevante em um arquivo markdown (*.prompt.md), que pode reutilizar em seus prompts de chat. Arquivos de prompt estão disponíveis somente no VS Code.

• A opção Usar Arquivos de Instrução deverá ser habilitada em suas configurações. Isso é habilitado por padrão. Confira Habilitando ou desabilitando instruções personalizadas de repositório mais adiante neste artigo.

As instruções contidas no arquivo .github/copilot-instructions.md ficam disponíveis para uso pelo Copilot Chat assim que você salva o arquivo. O conjunto completo de instruções será anexado automaticamente às solicitações enviadas na exibição do Copilot Chat ou no chat embutido.

As instruções personalizadas não ficam visíveis na exibição do Chat ou no chat embutido, mas você pode verificar se elas estão sendo usadas pelo Copilot observando a lista Referências de uma resposta na exibição do Chat. Se foram adicionadas instruções personalizadas à solicitação que foi enviada para o modelo, o arquivo .github/copilot-instructions.md será listado como uma referência. Selecione a referência para abrir o arquivo.

1. Abra o editor de Configurações usando o atalho de teclado Command+, (Mac)/CTRL+, (Linux/Windows).
2. Digite instruction file na caixa de pesquisa.
3. Marque ou desmarque a caixa de seleção em Geração de Código: Usar Arquivos de Instrução.

Sobre os arquivos de prompt

Os arquivos de prompt permitem que você crie e compartilhe instruções de prompt reutilizáveis com contexto adicional. Um arquivo de prompt é um arquivo markdown que imita o formato existente de escrita de prompts no Copilot Chat (por exemplo, Rewrite #file:x.ts). Isso permite mesclar instruções em linguagem natural, contexto adicional e até mesmo vincular a outros arquivos de prompt como dependências.

Embora instruções personalizadas ajudem a adicionar contexto de toda a base de código a cada fluxo de trabalho de IA, os arquivos de prompt permitem adicionar instruções a uma interação de chat específica.

Os casos de uso comuns incluem:

• Geração de código. Crie prompts reutilizáveis para componentes, testes ou migrações (por exemplo, formulários React ou simulações de API).
• Experiência no domínio. Compartilhe conhecimento especializado por meio de prompts, como práticas de segurança ou verificações de conformidade.
• Colaboração de equipe. Padrões e diretrizes de documento com referências a especificações e documentação.
• Integração. Crie guias passo a passo para processos complexos ou padrões específicos do projeto.

Exemplos de arquivo de prompt

Os exemplos a seguir demonstram como usar esses arquivos de prompt.

• react-form.prompt.md – documenta uma tarefa reutilizável para gerar um formulário.

  Your goal is to generate a new React form component.
  
  Ask for the form name and fields if not provided.
  
  Requirements for the form:
  - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
  - Use `react-hook-form` for form state management:
    - Always define TypeScript types for your form data
    - Prefer *uncontrolled* components using register
    - Use `defaultValues` to prevent unnecessary rerenders
  - Use `yup` for validation:
    - Create reusable validation schemas in separate files
    - Use TypeScript types to ensure type safety
    - Customize UX-friendly validation rules
  

• security-api.prompt.md – documenta práticas de segurança reutilizáveis para APIs REST, que podem ser usadas para fazer revisões de segurança das APIs REST.

  Secure REST API review:
  - Ensure all endpoints are protected by authentication and authorization
  - Validate all user inputs and sanitize data
  - Implement rate limiting and throttling
  - Implement logging and monitoring for security events
  …
  

Usando arquivos de prompt

Para habilitar arquivos de prompt, defina a configuração chat.promptFiles do VS Code. Defina-a como true ou use a notação { "/path/to/folder": boolean } para especificar um caminho diferente. Caminhos relativos são resolvidos das pastas raiz do workspace, e o valor padrão de .github/prompts é usado se nenhum outro caminho é fornecido. Para obter instruções mais detalhadas, confira a Referência de configurações do GitHub Copilot no VS Code na documentação do Visual Studio Code.

1. Crie um arquivo .prompt.md no diretório .github/prompts do workspace.

2. Escreva instruções de prompt usando a formatação de Markdown.

   Referencie arquivos de workspace adicionais como links de Markdown ([index](../index.ts)) ou como referências #file:../index.ts no arquivo de prompt. Você também pode referenciar outros arquivos .prompt.md.

3. Selecione o ícone de anexação e selecione Prompt... e escolha o arquivo de prompt para anexá-lo no Copilot Chat ou Copilot Edits.

4. Opcionalmente, anexe arquivos de contexto adicionais necessários para a tarefa.

5. Envie o prompt de chat.

   • Para tarefas reutilizáveis, envie o prompt sem instruções adicionais.
   • Inclua instruções adicionais para fornecer mais contexto para a tarefa em questão.