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

Para ter uma visão geral dos métodos que você pode usar para personalizar as respostas do GitHub Copilot Chat, consulte About customizing GitHub Copilot Chat responses.

Sobre as instruções personalizadas e os arquivos de prompt de repositório para o GitHub Copilot Chat

O GitHub Copilot pode fornecer respostas de chat adaptadas à maneira como sua equipe trabalha, às ferramentas que você usa ou às especificidades do seu projeto, caso você forneça contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual às suas perguntas de chat, você pode criar arquivos no repositório que adicionam automaticamente essas informações.

Você pode usar dois tipos de arquivos para fornecer contexto e instruções para o GitHub Copilot Chat no VS Code:

• As instruções personalizadas do repositório permitem especificar instruções e preferências em todo o repositório, em um só arquivo, que se aplicam a qualquer conversa ocorrida no contexto do repositório.
• Os arquivos de prompt (visualização pública) permitem que você salve instruções de prompt comuns e o contexto relevante em arquivos Markdown (*.prompt.md) que pode reutilizar em seus prompts de chat. Arquivos de prompt estão disponíveis somente no VS Code.

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.

Exemplo de instruções personalizadas de repositório

This example of a .github/copilot-instructions.md file contains three instructions that will be added to all chat questions.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Exemplos de arquivo de prompt

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

• New React form.prompt.md – contém instruções para uma tarefa reutilizável para gerar um formulário usando o React.

  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
  

• API security review.prompt.md – contém informações reutilizáveis sobre práticas de segurança 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
  …
  

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

Habilitando e usando 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 armazenado em seu workspace que imita o formato existente de escrita de prompts no Copilot Chat (por exemplo, Rewrite #file:x.ts). Você pode ter vários arquivos de prompt em seu workspace, cada um deles define um prompt para uma finalidade diferente.

Como habilitar arquivos de prompt

Para habilitar arquivos de prompt, defina as configurações do workspace.

1. Abra a paleta de comandos pressionando Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).
2. Digite "Abrir Configurações do Workspace (JSON)" e selecione a opção exibida.
3. No arquivo settings.json, adicione "chat.promptFiles": true para habilitar a pasta .github/prompts como o local para arquivos de prompt. Essa pasta será criada se ainda não existir.

Como criar arquivos de prompt

1. Abra a paleta de comandos pressionando Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).

2. Digite "prompt" e selecione Chat: Criar Prompt.

3. Insira um nome para o arquivo de prompt, excluindo a extensão de nome de arquivo .prompt.md. O nome pode conter caracteres alfanuméricos e espaços e deve descrever a finalidade das informações do prompt que o arquivo conterá.

4. Escreva as instruções do prompt usando formatação de Markdown.

   Você pode referenciar outros arquivos no workspace usando links markdown, por exemplo, [index](../../web/index.ts), ou usando a sintaxe #file:../../web/index.ts. Os caminhos são relativos ao arquivo de prompt. Fazer referência a outros arquivos permite que você forneça contexto adicional, como especificações de API ou a documentação do produto.

Usando arquivos de prompt

1. Na parte inferior da exibição Copilot Chat, clique no ícone Anexar contexto ().

2. No menu suspenso, clique em Prompt... e escolha o arquivo de prompt que você deseja usar.

3. Opcionalmente, anexe mais arquivos, incluindo arquivos de prompt, para fornecer mais contexto.

4. Você também pode digitar informações adicionais na caixa de prompt de chat.

   A necessidade de fazer isso dependerá do conteúdo do prompt que você está usando.

5. Envie o prompt de chat.

Para obter mais informações sobre arquivos de prompt, consulte Instruções personalizadas para o GitHub Copilot no VS Code na documentação do Visual Studio Code.