Como adicionar instruções personalizadas no GitHub Copilot

Você pode criar um arquivo que adiciona automaticamente as informações a todas as perguntas feitas ao Copilot Chat.

Neste artigo

Note

  • Atualmente, esse recurso está em versão prévia pública e sujeito a alterações.
  • No momento, só há suporte às instruções personalizadas para o Copilot Chat no VS Code e no Visual Studio.

Sobre as instruções personalizadas do GitHub Copilot

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 um arquivo que adiciona automaticamente essas informações para você. As informações adicionais não são exibidas no chat, mas estão disponíveis para o Copilot, a fim de permitir que ele gere respostas de maior qualidade.

Pré-requisitos

  • Um arquivo de instruções personalizado (confira as instruções abaixo).

  • A opção Usar Arquivos de Instruções (VS Code) ou Habilitar instruções personalizadas (Visual Studio) habilitada nas configurações. Confira Como habilitar ou desabilitar instruções personalizadas mais adiante neste artigo.

    Note

    A configuração é habilitada por padrão no VS Code e desabilitada por padrão no Visual Studio.

Como criar um arquivo de instruções personalizado

  1. No diretório do repositório, crie um arquivo chamado .github/copilot-instructions.md.

    Crie o diretório .github se ele ainda não existir.

  2. Adicione instruções em linguagem natural ao arquivo, no formato Markdown.

    O espaço em branco entre as instruções é ignorado, de modo que as instruções podem ser escritas como um só parágrafo, cada uma em uma nova linha ou separadas por linhas em branco para facilitar a leitura.

Exemplos de instruções

Este exemplo de um arquivo .github/copilot-instructions.md contém três instruções que serão adicionadas a todas as perguntas de chat.

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.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo .github/copilot-instructions.md devem ser instruções curtas e autossuficientes que adicionam contexto ou informações relevantes para complementar as perguntas de chat dos usuários.

Os seguintes tipos de instruções provavelmente não funcionarão conforme desejado e podem causar problemas com outras áreas do Copilot:

  • Solicitações para referência a recursos externos ao formular uma resposta
  • Instruções para resposta em um estilo específico
  • Solicitações para sempre responder com determinado nível de detalhes

Portanto, é improvável que as seguintes instruções tenham o resultado pretendido:

Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.

Instruções personalizadas em uso

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, no VS Code e no Visual Studio.

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

Captura de tela da exibição do Copilot Chat no VS Code com uma referência ao arquivo copilot-instructions.md.

Como habilitar ou desabilitar instruções personalizadas

Você pode escolher se deseja ou não adicionar instruções personalizadas às suas perguntas de chat. Para fazer isso, marque ou desmarque a opção nas configurações da extensão Copilot.

No VS Code

  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.

No Visual Studio

  1. Na barra de menus do Visual Studio, em Ferramentas, clique em Opções.

    Captura de tela da barra de menus do Visual Studio. O menu "Ferramentas" está expandido e o item "Opções" está realçado com um contorno em laranja.

  2. Na caixa de diálogo “Opções”, digite custom instructions na caixa de pesquisa.

  3. Marque ou desmarque a caixa de seleção de (Versão prévia) Habilitar instruções personalizadas a serem carregadas dos arquivos .github/copilot-instructions.md e adicionadas às solicitações.