Instruções personalizadas para GitHub Copilot

Sobre como personalizar Copilot respostas

GitHub Copilot pode fornecer respostas adaptadas às suas preferências, à maneira como sua equipe funciona, às ferramentas que você usa e às especificidades do projeto. Em vez de adicionar repetidamente o mesmo contexto aos prompts, você pode criar instruções personalizadas que fornecem automaticamente essas informações para permitir que Copilot gere respostas de maior qualidade.

Os arquivos de prompt fornecem outra maneira de fornecer Copilot instruções e contexto específicos à tarefa. Ao contrário das instruções personalizadas, você escolhe quando usá-las em um chat. Para obter mais informações, consulte Arquivos de prompt para GitHub Copilot.

Os tipos de instruções personalizadas disponíveis e os Copilot recursos que as usam variam de acordo com o cliente e a superfície (GitHub.com, Visual Studio Code, Visual Studio, JetBrains IDEs Xcode e Eclipse). Para verificar quais tipos o seu ambiente suporta, consulte Suporte para diferentes tipos de instruções personalizadas. Para versões e IDEs com suporte, consulte matriz de recursos Copilot.

Observação

Devido à natureza não determinística da IA, Copilot pode nem sempre seguir suas instruções personalizadas exatamente da mesma maneira sempre que forem usadas.

Tipos de instruções personalizadas

Instruções personalizadas podem ser aplicadas em diferentes níveis:

Tipo	Scope	Exemplos de uso
Instruções pessoais	Suas conversas com Copilot	Especifique suas preferências individuais, como idioma preferencial ou estilo de resposta.
Instruções personalizadas do repositório	Conversas com Copilot executadas no contexto de um repositório, projeto, caminho ou agente com suporte	Descreva as linguagens, estruturas, ferramentas, arquitetura e convenções de codificação usadas em um projeto.
Instruções personalizadas da organização	Conversas com Copilot quando usado no contexto de uma organização	Forneça diretrizes de linguagem, segurança, conformidade ou resposta em toda a organização.

Alguns clientes (JetBrains IDEs e Xcode) fornecem mecanismos adicionais de instrução global, de workspace ou de projeto. Nem sempre esses mecanismos são mapeados diretamente para instruções pessoais, de repositório e de organização em GitHub.

Sobre instruções pessoais

Instruções pessoais configuradas em GitHub.com aplicam-se a GitHub Copilot Chat in GitHub. Outros clientes, como Copilot CLI, usam arquivos locais para instruções pessoais. Consulte Adicionando instruções personalizadas para GitHub Copilot CLI.

Você pode personalizar como Copilot Chat responde a você em GitHub.com adicionando instruções pessoais. Estas instruções se aplicam somente a você. Por exemplo, você pode especificar seu idioma preferido, o nível de detalhes desejado ou como deseja que as respostas sejam estruturadas. Consulte Adicionando instruções personalizadas pessoais para GitHub Copilot.

Sobre instruções personalizadas de repositório

As instruções personalizadas do repositório fornecem o contexto e as diretrizes específicos do projeto. Por exemplo, você pode descrever a finalidade do repositório, as estruturas e as ferramentas que ele usa e as convenções de codificação ou teste que os colaboradores devem seguir.

Há três tipos principais de instruções personalizadas do repositório:

          **Instruções personalizadas para todo o repositório**, que se aplicam a todas as solicitações feitas no contexto de um repositório.

Elas são especificados em um arquivo copilot-instructions.md no diretório .github do repositório.

```
          **Instruções personalizadas específicas do caminho**, que se aplicam a solicitações feitas no contexto de arquivos que correspondem a um caminho especificado.
```
Eles são especificados em um ou mais NAME.instructions.md arquivos dentro ou abaixo do .github/instructions diretório no repositório.

Usando instruções específicas do caminho, você pode evitar sobrecarregar suas instruções em todo o repositório com informações que se aplicam apenas a arquivos de determinados tipos ou em determinados diretórios.

          **Instruções do agente**, que são semelhantes às instruções personalizadas aplicáveis a todo o repositório, mas que atualmente não são suportadas por todos os recursos do Copilot.

Eles são especificados em arquivos chamados AGENTS.md, CLAUDE.mdou GEMINI.md.

Para obter detalhes sobre o suporte para cada um desses tipos de instruções personalizadas do repositório em diferentes recursos do Copilot, consulte Suporte para diferentes tipos de instruções personalizadas.

Para obter uma coleção de exemplos selecionada, consulte Instruções personalizadas.

Observe que os arquivos de instrução do agente, como AGENTS.md, fornecem instruções aos agentes de IA com suporte. Eles são diferentes dos arquivos de definição de agente personalizados armazenados em .github/agents, que definem agentes especializados e sua configuração. Para obter os nomes de arquivo de instrução do agente que Copilot reconhece, consulte Suporte para diferentes tipos de instruções personalizadas.

Instruções personalizadas do repositório em clientes e interfaces

Quais tipos de instruções personalizadas de repositório você pode usar (instruções de repositório, específicas de caminho ou agente) dependem do seu ambiente e da tarefa, como conversar, trabalhar na nuvem ou revisar uma solicitação de pull. Por exemplo, um ambiente pode dar suporte a instruções específicas de caminho para uma tarefa, mas não outra. Para verificar o suporte para sua configuração, consulte Suporte para diferentes tipos de instruções personalizadas. Para versões e IDEs com suporte, consulte matriz de recursos Copilot.

Sobre instruções personalizadas da organização

Observação

Suporte: No momento, há suporte para instruções personalizadas da organização para sessões em execução no site GitHub (em sandboxes na nuvem ou em GitHub Actions) e para Copilot code review. Eles não são compatíveis em sessões de cliente locais.

Os proprietários da organização podem adicionar instruções para adaptar Copilot às necessidades e preferências de sua organização. Essas instruções são usadas para todos os membros da organização, independentemente de receberem sua assinatura de Copilot dessa organização.

As instruções personalizadas da organização só podem ser configuradas para organizações com uma assinatura Copilot Enterprise ou Copilot Business.

Por exemplo, as instruções da organização podem:

Especifique um idioma que deve ser usado em respostas.
Forneça diretrizes de segurança ou conformidade em toda a organização.
Especifique formatos de resposta preferenciais, como não gerar blocos de código.
Direcione as pessoas para uma base de dados de conhecimento interna ou canal de suporte para tópicos específicos.

Para obter informações sobre como adicionar instruções da organização, consulte Como adicionar instruções personalizadas de organização no GitHub Copilot.

Precedência de instruções personalizadas

A precedência depende do cliente e do recurso. A maioria das superfícies e clientes, incluindo Copilot CLI, Visual Studio Code e Visual Studio, combinam arquivos de instrução aplicáveis sem definir uma ordem de precedência geral.

Para Copilot Chat em GitHub.com, todas as instruções relevantes são fornecidas para Copilot. A ordem de precedência, da mais alta para a mais baixa, é:

Instruções pessoais
Instruções personalizadas do repositório:
1. Instruções específicas do caminho em qualquer arquivo .github/instructions/**/*.instructions.md aplicável
2. Instruções em todo o repositório em .github/copilot-instructions.md
3. Instruções do agente, como instruções em um AGENTS.md arquivo
Instruções personalizadas da organização

Sempre que possível, tente evitar fornecer conjuntos conflitantes de instruções. Se você estiver preocupado com a qualidade da resposta, poderá desabilitar temporariamente as instruções do repositório. Confira Adicionando instruções personalizadas do repositório para GitHub Copilot.

Como usar instruções personalizadas

As instruções personalizadas consistem em instruções de linguagem natural e são mais eficazes quando são curtas e independentes. Considere o escopo sobre o qual você deseja aplicar uma instrução antes de decidir se deseja adicioná-la no nível pessoal, repositório ou organização.

Os casos de uso comuns incluem:

Preferências de resposta. Especifique um idioma preferencial, estrutura de resposta, tom ou nível de explicação.
Contexto do projeto. Explicar a finalidade, a arquitetura ou o domínio de um repositório.
Linguagens e frameworks. Identifique os idiomas, bibliotecas, frameworks e versões usadas por um projeto.
Convenções de codificação e teste. Descreva os padrões de nomenclatura, formatação, teste, tratamento de erros ou documentação.
Revisão e diretrizes de segurança. Identifique problemas que devem receber atenção especial ao revisar ou alterar código em um recurso compatível.
Requisitos da organização. Forneça diretrizes de suporte, segurança, conformidade ou idioma em toda a organização.

Por exemplo:

Instrução pessoal: Always respond in Portuguese.
Instruções pessoais: Explain a single concept per line. Be clear and concise.
Instrução do repositório: Use Vue with the PrimeVue library.
Instrução do repositório: Use early returns whenever possible.
Instrução da organização: For questions related to security, use the Security Docs Knowledge Base.
Instrução da organização: Do not generate code blocks in responses.

Instruções sobre teste, mensagens de commit ou revisão de código podem fornecer contexto útil. No entanto, os Copilot recursos que usam uma instrução específica variam de acordo com o cliente e a superfície, e as instruções personalizadas não garantem que o conteúdo gerado esteja em conformidade com uma política.

Observação

Ao examinar uma pull request, Copilot leia instruções personalizadas de repositório, instruções de agente e habilidades de agente da ramificação principal (a ramificação com as alterações), e não a ramificação base. Por exemplo, ao mesclar my-feature-branch em main, Copilot usa as instruções e habilidades em my-feature-branch, para que você possa testar alterações nelas no mesmo pull request sem mesclá-las primeiro.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona aos seus arquivos de instrução personalizados devem ser instruções curtas e autocontidas que fornecem Copilot informações relevantes para ajudá-lo a trabalhar neste repositório. Como as instruções são enviadas com cada mensagem de chat, elas devem ser amplamente aplicáveis à maioria das solicitações que você fará no contexto do repositório.

A estrutura exata usada para seus arquivos de instruções variará de acordo com o projeto e a necessidade, mas as diretrizes a seguir fornecem um bom ponto de partida:

Forneça uma visão geral do projeto no qual você está trabalhando, incluindo a finalidade, as metas e demais informações contextuais relevantes.
Especifique os padrões de codificação e as convenções que devem ser seguidas, como convenções de nomenclatura, regras de formatação e práticas recomendadas.
Inclua outras ferramentas, bibliotecas ou estruturas específicas usadas no projeto, juntamente com números de versão ou configurações relevantes.

O arquivo de instruções a seguir é um exemplo dessas práticas em ação:

# Project Overview

This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.

## Libraries and Frameworks

- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.

## Coding Standards

- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.

## UI guidelines

- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.

Considere também o tamanho e a complexidade do repositório. Os seguintes tipos de instruções podem funcionar para um pequeno repositório com apenas alguns colaboradores, mas para um repositório grande e diversificado, isso pode causar problemas:

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.