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

Crie um arquivo em um repositório que fornece contexto adicional ao Copilot para o trabalho que ele faz nesse repositório.

Neste artigo

Observação

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 de repositório para o Copilot Chat no Visual Studio, VS Code e no site do GitHub. Eles também têm suporte para Agente de codificação do Copilot.

Esta versão deste artigo destina-se ao uso de instruções personalizadas de repositório no site do GitHub. Clique nas guias acima para obter informações sobre como usar instruções personalizadas em outros ambientes.

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. Para obter informações sobre como personalizar o Agente de codificação do Copilot, confira Como personalizar o ambiente de desenvolvimento para o agente de codificação do Copilot.

Sobre as instruções personalizadas de repositório para o 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 no repositório 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.

O arquivo de instruções personalizadas também é usado por Copilot quando você o atribui a um issue ou solicita que ele crie uma pull request. As instruções incluídas neste arquivo podem ajudar Copilot a trabalhar em arquivos de um modo que corresponda às práticas de trabalho da sua equipe e esteja em conformidade com os padrões de codificação do seu projeto. Confira Sobre a atribuição de tarefas ao Copilot.

Exemplo

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.

Pré-requisitos para instruções personalizadas de repositório

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

Criando um arquivo de instruções personalizadas de repositório

  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 elas podem ser escritas como um só parágrafo, cada uma em uma nova linha ou separadas por linhas em branco para facilitar a leitura.

Para ver as instruções em ação, vá para https://github.com/copilot, anexe o repositório que contém o arquivo de instruções e inicie uma conversa.

Adicionou com êxito um arquivo de instruções personalizado ao repositório?

Sim Não

Escrevendo instruções personalizadas de repositório 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.

Considere também o tamanho e a complexidade do repositório. Os seguintes tipos de instruções podem funcionar para um repositório pequeno com apenas alguns colaboradores, mas para um repositório grande e diversificado, elas 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

Por exemplo, as seguintes instruções podem não ter os resultados pretendidos:

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 de repositório 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á adicionado automaticamente aos prompts de chat relacionados ao repositório que contém o arquivo de instruções.

Na exibição imersiva do Copilot Chat (github.com/copilot), você pode iniciar uma conversa que usa instruções personalizadas de repositório adicionando, como anexo, o repositório que contém o arquivo de instruções.

Sempre que instruções personalizadas de repositório são usadas pelo Copilot Chat, o arquivo de instruções é adicionado como uma referência para a resposta gerada. Para descobrir se instruções personalizadas de repositório foram usadas, expanda a lista de referências na parte superior de uma resposta de chat no painel Chat e verifique se o arquivo .github/copilot-instructions.md está listado.

Captura de tela de uma lista de Referências expandida, mostrando o arquivo "copilot-instructions.md" realçado com um contorno laranja escuro.

Selecione a referência para abrir o arquivo.

Observação

  • É possível que vários tipos de instruções personalizadas se apliquem a uma conversa. Instruções pessoais assumem a prioridade mais alta, seguidas pelas instruções do repositório, com as instruções da organização priorizadas por último. No entanto, todos os conjuntos de instruções relevantes ainda são combinados e fornecidos ao Copilot Chat.
  • Sempre que possível, você deve evitar fornecer conjuntos conflitantes de instruções. Se estiver preocupado com a qualidade da resposta, você também poderá optar por desabilitar temporariamente as instruções do repositório. Confira Como adicionar instruções personalizadas de repositório no GitHub Copilot.

Habilitando ou desabilitando instruções personalizadas de repositório

Você pode escolher se deseja ou não adicionar instruções personalizadas às suas perguntas de chat.

  1. Clique no botão na parte superior do painel do Chat ou no canto superior direito da página imersiva.

  2. Clique em Desabilitar instruções personalizadas ou Habilitar instruções personalizadas.

    Observação

    No modo imersivo, você só verá essas opções se tiver anexado um repositório que contenha um arquivo de instruções personalizado.

Sua escolha persistirá até você alterá-la.