Adicionando instruções personalizadas de repositório para o GitHub Copilot em seu IDE

Crie arquivos de instruções personalizadas do repositório que fornecem Copilot contexto adicional sobre como entender seu projeto e como criar, testar e validar suas alterações.

Tool navigation

Neste artigo

Esta versão deste artigo destina-se ao uso de instruções personalizadas do repositório e arquivos de prompt em VS Code. Clique nas guias acima para saber como usar instruções personalizadas em outros ambientes.

Introdução

As instruções personalizadas de repositório permitem fornecer orientações e preferências específicas do repositório ao Copilot. Para saber mais, confira Sobre a personalização das respostas do GitHub Copilot.

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

Como criar instruções personalizadas

          VS Code dá suporte a três tipos de instruções personalizadas do repositório. Para obter detalhes sobre quais GitHub Copilot recursos dão suporte a esses tipos de instruções, consulte [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=vscode#support-for-repository-custom-instructions-1).

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

    Eles são especificados em um arquivo copilot-instructions.md no diretório .github do repositório. Consulte Como criar instruções personalizadas em todo o 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 arquivos NAME.instructions.md dentro ou abaixo do diretório .github/instructions no repositório. Consulte Como criar instruções personalizadas específicas do caminho.

    Se o caminho especificado corresponder a um arquivo no qual Copilot está trabalhando e também existir um arquivo de instruções personalizadas no repositório, as instruções de ambos os arquivos serão usadas.

  • Instruções do agente são usadas por agentes de IA.

    Você pode criar um ou mais arquivos AGENTS.md armazenados em qualquer lugar no repositório. Quando Copilot estiver funcionando, o arquivo mais próximo AGENTS.md na árvore de diretório terá precedência. Para obter mais informações, consulte o repositório agentsmd/agents.md.

    Observação

    O suporte a AGENTS.md arquivos fora da raiz do workspace está desativado por padrão. Para obter detalhes sobre como habilitar esse recurso, consulte Usar instruções personalizadas no VS Code na VS Code documentação.

Como criar instruções personalizadas em todo o repositório

  1. Na raiz 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.

Criar instruções personalizadas específicas para o caminho

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

  2. Opcionalmente, crie subdiretórios de .github/instructions para organizar seus arquivos de instrução.

  3. Crie um ou mais arquivos NAME.instructions.md, em que NAME indica a finalidade das instruções. O nome do arquivo deve terminar com .instructions.md.

  4. No início do arquivo, crie um bloco frontmatter contendo a palavra-chave applyTo. Use a sintaxe glob para especificar a quais arquivos ou diretórios as instruções se aplicam.

    Por exemplo:

    ---
applyTo: "app/models/**/*.rb"
---

    Você pode especificar vários padrões separando-os com vírgulas. Por exemplo, para aplicar as instruções a todos os arquivos TypeScript no repositório, você pode usar o seguinte bloco frontmatter:

    ---
applyTo: "**/*.ts,**/*.tsx"
---

    Exemplos do Glob:

    • * – corresponderá a todos os arquivos no diretório atual.
    • ** ou **/* – todos corresponderão a todos os arquivos em todos os diretórios.
    • *.py – corresponderá a todos os .py arquivos no diretório atual.
    • **/*.py – corresponderá recursivamente a todos os .py arquivos em todos os diretórios.
    • src/*.py – corresponderá a todos os .py arquivos no src diretório. Por exemplo, src/foo.py mas src/bar.pynãosrc/foo/bar.py.
    • src/**/*.py – corresponderá recursivamente a todos os .py arquivos no src diretório. Por exemplo, src/foo.py, src/foo/bar.py e src/foo/bar/baz.py.
    • **/subdir/**/*.py – fará a correspondência recursiva de todos os arquivos .py em qualquer diretório subdir em qualquer profundidade. Por exemplo, subdir/foo.py, subdir/nested/bar.py, parent/subdir/baz.pye deep/parent/subdir/nested/qux.py, mas nãofoo.py em um caminho que não contém um subdir diretório.

  5. Opcionalmente, para impedir que o arquivo seja usado por agente de nuvem Copilot ou Revisão de código do Copilot, adicione a palavra-chave excludeAgent ao bloco de frontmatter. Use "code-review" ou "cloud-agent".

    Por exemplo, o arquivo a seguir será lido apenas por agente de nuvem Copilot.

    ---
applyTo: "**"
excludeAgent: "code-review"
---

    Se a palavra-chave excludeAgent não estiver incluída no bloco front-matter, tanto o Revisão de código do Copilot quanto o agente de nuvem Copilot usarão suas instruções.

  6. Adicione suas instruções personalizadas em linguagem natural usando o 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.

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

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

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.

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

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

Você pode escolher se quer ou não que o Copilot use instruções personalizadas baseadas em repositório.

Habilitar ou desabilitar instruções personalizadas para o Bate-papo do Copilot

As instruções personalizadas são habilitadas para o Bate-papo do Copilot por padrão, mas você pode desabilitá-las ou reabilitá-las a qualquer momento. Isso se aplica ao seu próprio uso do Bate-papo do Copilot e não afeta outros usuários.

  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.

Como habilitar ou desabilitar instruções personalizadas do repositório para o Revisão de código do Copilot

As instruções personalizadas são habilitadas para o Revisão de código do Copilot por padrão, mas você pode desabilitá-las ou reabilitá-los nas configurações do repositório em GitHub.com. Isso se aplica ao uso do Copilot de instruções personalizadas para todas as revisões de código executadas neste repositório.

  1. Em GitHub, acesse a página principal do repositório.

  2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na seção "Code & automation" da barra lateral, clique em Copilot e em Code review.

  4. Ative ou desative a opção "Use custom instructions when reviewing pull requests".

Habilitando e usando arquivos de prompt

Observação

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 espaço de trabalho, que imita o formato existente de redação de prompts em Bate-papo do Copilot (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 Bate-papo do Copilot , 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 Usar arquivos de prompt na Visual Studio CodeVisual Studio Code documentação.

Leitura adicional

Esta versão deste artigo é destinada ao uso de instruções personalizadas do repositório e arquivos de prompt em Visual Studio. Clique nas guias acima para saber como usar instruções personalizadas em outros ambientes.

Introdução

As instruções personalizadas de repositório permitem fornecer orientações e preferências específicas do repositório ao Copilot. Para saber mais, confira Sobre a personalização das respostas do GitHub Copilot.

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

Como criar instruções personalizadas

          Visual Studio dá suporte a dois tipos de instruções personalizadas. Para obter detalhes sobre quais GitHub Copilot recursos dão suporte a esses tipos de instruções, consulte [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=visualstudio#support-for-repository-custom-instructions-2).

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

    Eles são especificados em um arquivo copilot-instructions.md no diretório .github do repositório. Consulte Como criar instruções personalizadas em todo o 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 arquivos NAME.instructions.md dentro ou abaixo do diretório .github/instructions no repositório. Consulte Como criar instruções personalizadas específicas do caminho.

    Se o caminho especificado corresponder a um arquivo no qual Copilot está trabalhando e também existir um arquivo de instruções personalizadas no repositório, as instruções de ambos os arquivos serão usadas.

Como criar instruções personalizadas em todo o repositório

  1. Na raiz 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.

Criar instruções personalizadas específicas para o caminho

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

  2. Opcionalmente, crie subdiretórios de .github/instructions para organizar seus arquivos de instrução.

  3. Crie um ou mais arquivos NAME.instructions.md, em que NAME indica a finalidade das instruções. O nome do arquivo deve terminar com .instructions.md.

  4. No início do arquivo, crie um bloco frontmatter contendo a palavra-chave applyTo. Use a sintaxe glob para especificar a quais arquivos ou diretórios as instruções se aplicam.

    Por exemplo:

    ---
applyTo: "app/models/**/*.rb"
---

    Você pode especificar vários padrões separando-os com vírgulas. Por exemplo, para aplicar as instruções a todos os arquivos TypeScript no repositório, você pode usar o seguinte bloco frontmatter:

    ---
applyTo: "**/*.ts,**/*.tsx"
---

    Exemplos do Glob:

    • * – corresponderá a todos os arquivos no diretório atual.
    • ** ou **/* – todos corresponderão a todos os arquivos em todos os diretórios.
    • *.py – corresponderá a todos os .py arquivos no diretório atual.
    • **/*.py – corresponderá recursivamente a todos os .py arquivos em todos os diretórios.
    • src/*.py – corresponderá a todos os .py arquivos no src diretório. Por exemplo, src/foo.py mas src/bar.pynãosrc/foo/bar.py.
    • src/**/*.py – corresponderá recursivamente a todos os .py arquivos no src diretório. Por exemplo, src/foo.py, src/foo/bar.py e src/foo/bar/baz.py.
    • **/subdir/**/*.py – fará a correspondência recursiva de todos os arquivos .py em qualquer diretório subdir em qualquer profundidade. Por exemplo, subdir/foo.py, subdir/nested/bar.py, parent/subdir/baz.pye deep/parent/subdir/nested/qux.py, mas nãofoo.py em um caminho que não contém um subdir diretório.

  5. Opcionalmente, para impedir que o arquivo seja usado por agente de nuvem Copilot ou Revisão de código do Copilot, adicione a palavra-chave excludeAgent ao bloco de frontmatter. Use "code-review" ou "cloud-agent".

    Por exemplo, o arquivo a seguir será lido apenas por agente de nuvem Copilot.

    ---
applyTo: "**"
excludeAgent: "code-review"
---

    Se a palavra-chave excludeAgent não estiver incluída no bloco front-matter, tanto o Revisão de código do Copilot quanto o agente de nuvem Copilot usarão suas instruções.

  6. Adicione suas instruções personalizadas em linguagem natural usando o 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.

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

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

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.

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

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

Você pode escolher se quer ou não que o Copilot use instruções personalizadas baseadas em repositório.

Habilitar ou desabilitar instruções personalizadas para o Bate-papo do Copilot

As instruções personalizadas são habilitadas para o Bate-papo do Copilot por padrão, mas você pode desabilitá-las ou reabilitá-las a qualquer momento. Isso se aplica ao seu próprio uso do Bate-papo do Copilot e não afeta outros usuários.

  1. Na barra de Visual Studio menus, 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 e depois clique em Copilot.

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

    Captura de tela da caixa de diálogo Opções do Visual Studio mostrando a caixa de seleção "Habilitar instruções personalizadas" selecionada.

Como habilitar ou desabilitar instruções personalizadas do repositório para o Revisão de código do Copilot

As instruções personalizadas são habilitadas para o Revisão de código do Copilot por padrão, mas você pode desabilitá-las ou reabilitá-los nas configurações do repositório em GitHub.com. Isso se aplica ao uso do Copilot de instruções personalizadas para todas as revisões de código executadas neste repositório.

  1. Em GitHub, acesse a página principal do repositório.

  2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na seção "Code & automation" da barra lateral, clique em Copilot e em Code review.

  4. Ative ou desative a opção "Use custom instructions when reviewing pull requests".

Usando arquivos de prompt

Observação

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 espaço de trabalho, que imita o formato existente de redação de prompts em Bate-papo do Copilot (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 criar arquivos de prompt

  1. Adicione um arquivo de prompt, incluindo a extensão de arquivo .prompt.md dentro da pasta .github/prompts na raiz do repositório. O nome pode conter caracteres alfanuméricos e espaços e deve descrever a finalidade das informações do prompt que o arquivo conterá.

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

Para obter mais informações sobre arquivos de prompt, consulte Usar arquivos de prompt em Visual Studio na Visual Studio documentação.

Leitura adicional

A versão deste artigo destina-se ao uso de instruções personalizadas de repositório nos IDEs do JetBrains. Clique nas guias acima para saber como usar instruções personalizadas em outros ambientes.

Introdução

As instruções personalizadas de repositório permitem fornecer orientações e preferências específicas do repositório ao Copilot. Para saber mais, confira Sobre a personalização das respostas do GitHub Copilot.

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

  • Você deve ter um arquivo de instruções personalizado (confira as instruções abaixo).

  • A versão mais recente da Copilot extensão deve ser instalada no IDE do JetBrains.

Como criar instruções personalizadas

Os IDEs do JetBrains dão suporte a um único arquivo de instruções personalizado .github/copilot-instructions.md armazenado no repositório e um arquivo global-copilot-instructions.md armazenado localmente.

Você pode criar o .github/copilot-instructions.md arquivo em seu repositório usando a Copilot página de configurações ou pode criar o arquivo manualmente.

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.

Usar a página de configurações

  1. No seu IDE JetBrains, clique no menu Arquivo (Windows) ou no nome do aplicativo na barra de menus (macOS) e clique em Configurações.

           1. Na barra lateral esquerda, clique em **Ferramentas**, clique **em GitHub Copilot**, em seguida, clique em **Personalizações**.

  2. Em "Copilot Instruções", clique em Workspace ou Global para escolher se as instruções personalizadas se aplicam ao workspace atual ou a todos os workspaces.

Criar manualmente um arquivo de instruções personalizadas do workspace

  1. Na raiz 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.

Estas instruções, depois de salvas, serão aplicadas ao espaço de trabalho atual nas IDEs do JetBrains que você abrir com Copilot habilitado.

Criar manualmente um arquivo de instruções personalizadas global

Para aplicar as mesmas instruções em todos os workspaces em IDEs do JetBrains, você pode criar um arquivo de instruções personalizadas global em seu computador local.

  1. Abra o explorador de arquivos ou o terminal.

  2. Navegue até o local de acordo com seu sistema operacional:

    • macOS: /Users/YOUR-USERNAME/.config/github-copilot/intellij/
    • Windows: C:\Users\YOUR-USERNAME\AppData\Local\github-copilot\intellij\

  3. Crie um arquivo chamado global-copilot-instructions.md nesse diretório.

  4. Adicione suas instruções personalizadas em linguagem natural usando o formato Markdown.

Depois de salvas, essas instruções serão aplicadas globalmente em todos os workspaces nos IDEs da JetBrains que você abrir com Copilot habilitado.

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

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

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.

Usando arquivos de prompt

Observação

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 espaço de trabalho, que imita o formato existente de redação de prompts em Bate-papo do Copilot (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.

Ao escrever instruções de prompt, 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.

Depois que os arquivos de prompt forem salvos, as instruções serão aplicadas ao espaço de trabalho atual nos IDEs do JetBrains que você abrir com Copilot habilitado.

Criando arquivos de prompt usando a linha de comando

  1. Crie o .github/prompts diretório se ele ainda não existir em seu workspace. Esse diretório será o local para seus arquivos de prompt.
  2. Crie um arquivo de prompt no .github/prompts diretório. O nome do arquivo de prompt pode conter caracteres alfanuméricos e espaços e deve descrever a finalidade das informações de prompt que o arquivo conterá. O nome do arquivo deve terminar com a extensão .prompt.md, por exemplo TESTPROMPT.prompt.md.
  3. Escreva as instruções de prompt usando a formatação do Markdown e salve o arquivo.

Criando arquivos de prompt usando a página de configurações

  1. No seu IDE JetBrains, clique no menu Arquivo (Windows) ou no nome do aplicativo na barra de menus (macOS) e clique em Configurações.
  2. Em Ferramentas, em GitHub Copilot, clique em Editar Configurações.
  3. Em "Categorias de Configurações", clique em Personalizações.
  4. Em "Arquivos de Prompt", clique em Workspace para criar um arquivo de prompt em seu workspace.
  5. Insira um nome para o arquivo de prompt, excluindo a extensão de nome de arquivo .prompt.md. O nome do arquivo de prompt pode conter caracteres alfanuméricos e espaços e deve descrever a finalidade das informações de prompt que o arquivo conterá.
  6. Clique em Ok para salvar o nome do arquivo de prompt.
  7. Escreva as instruções de prompt usando a formatação do Markdown e salve o arquivo.

Usando arquivos de prompt

  1. Na caixa de entrada do chat, digite / seguido pelo nome do arquivo de prompt. Por exemplo, /TESTPROMPT.

  2. Opcionalmente, anexe arquivos adicionais para fornecer mais contexto.

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

  4. Envie o prompt de chat.

Leitura adicional

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

Introdução

As instruções personalizadas de repositório permitem fornecer orientações e preferências específicas do repositório ao Copilot. Para saber mais, confira Sobre a personalização das respostas do GitHub Copilot.

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

  • Você deve ter um arquivo de instruções personalizado (confira as instruções abaixo).

  • A versão mais recente da Copilot extensão deve ser instalada no Xcode.

Como criar instruções personalizadas

O Xcode dá suporte a um único arquivo de instruções personalizado .github/copilot-instructions.md armazenado no repositório.

Você pode criar um arquivo de instruções personalizado em seu repositório por meio da Copilot página de configurações.

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.

  1. Abra o GitHub Copilot aplicativo Xcode.
  2. Na parte superior da janela do aplicativo, em Configurações, clique em Avançado.
  3. À direita de "Instruções Personalizadas", clique em Workspace Atual ou Global para escolher se as instruções personalizadas se aplicam ao workspace atual ou a todos os workspaces.

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

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

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.

Leitura adicional

Observação

Esse recurso está atualmente dentro versão prévia pública e está sujeito a alterações.

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

Introdução

As instruções personalizadas de repositório permitem fornecer orientações e preferências específicas do repositório ao Copilot. Para saber mais, confira Sobre a personalização das respostas do GitHub Copilot.

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

  • Você deve ter um arquivo de instruções personalizado (confira as instruções abaixo).

  • A versão mais recente da Copilot extensão deve ser instalada no Eclipse.

Como criar instruções personalizadas

O Eclipse dá suporte a dois tipos de instruções personalizadas de repositório: instruções personalizadas de workspace e projeto.

Para criar um arquivo de instruções personalizadas do workspace, você pode usar a Copilot página de configurações. Para criar um arquivo de instruções personalizadas do projeto, crie o arquivo manualmente no diretório do projeto.

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.

Criar um arquivo de instruções personalizadas de workspace

  1. Para abrir o painel Bate-papo do Copilot, clique no ícone Copilot () na barra de status localizada na parte inferior do Eclipse.
  2. No menu, selecione "Edit preferences".
  3. No painel esquerdo, expanda GitHub Copilot e clique em Instruções Personalizadas.
  4. Selecione Habilitar instruções do workspace.
  5. Na seção "Workspace", em "Definir instruções personalizadas para orientar Copilot as sugestões de código nesta área de trabalho", adicione instruções em linguagem natural no arquivo, utilizando o formato Markdown.

Criar um arquivo de instruções personalizadas do projeto

  1. Na raiz do diretório do projeto, crie um arquivo chamado .github/copilot-instructions.md.
  2. Adicione suas instruções personalizadas em linguagem natural usando o formato Markdown.

Depois de salvas, essas instruções serão aplicadas ao projeto atual no Eclipse que você abrirá com Copilot habilitado.

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

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sim</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Não</span></a>

Instruções personalizadas em uso

As instruções nos arquivos estarão disponíveis para uso por Copilot assim que você salvar os arquivos. As instruções são adicionadas automaticamente às solicitações que você envia para Copilot.

Leitura adicional