Observação
Atualmente, esse recurso está em versão prévia pública e sujeito a alterações.
Repository custom instructions are currently supported for Copilot Chat in Visual Studio, VS Code and on the GitHub website.
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 , consulte About customizing GitHub Copilot Chat responses.
Sobre as instruções personalizadas de repositório parao
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.
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).
- Sua escolha pessoal de usar instruções personalizadas deve ser definida como habilitada. Isso é habilitado por padrão. Confira Habilitando ou desabilitando instruções personalizadas de repositório mais adiante neste artigo.
- Durante a versão prévia pública, se você estiver usando um plano do ou do , a organização ou empresa que fornece seu plano precisa ter a configuração Opt in to preview features habilitada. Confira Gerenciar políticas do Copilot na sua organização e Gerenciando políticas e recursos do Copilot em sua empresa.
Criando um arquivo de instruções personalizadas de repositório
-
No diretório do repositório, crie um arquivo chamado
.github/copilot-instructions.md.Crie o diretório
.githubse ele ainda não existir. -
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.
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 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 (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 , 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.
Selecione a referência para abrir o arquivo.
Observação
- It is possible for multiple types of custom instructions to apply to a conversation. Personal instructions take the highest priority, followed by repository instructions, with organization instructions prioritized last. However, all sets of relevant instructions are still combined and provided to Copilot Chat.
- Whenever possible, you should avoid providing conflicting sets of instructions. If you are concerned about response quality, you can also choose to temporarily disable repository instructions. See 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.
-
Clique no botão na parte superior do painel do Chat ou no canto superior direito da página imersiva.
-
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.
