Skip to main content

Sobre a personalização das respostas do GitHub Copilot

Saiba mais sobre como personalizar o comportamento de GitHub Copilot para que ele atenda às suas preferências e requisitos.

Observação

Esta versão deste artigo é sobre instruções personalizadas no GitHub site. Clique nas guias acima para outros ambientes.

Sobre como personalizar Copilot respostas

          GitHub Copilot pode fornecer respostas adaptadas às suas preferências pessoais, à maneira como sua equipe funciona, às ferramentas que você usa ou às especificidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos seus prompts, você pode criar instruções personalizadas que adicionam automaticamente essas informações para você. As informações adicionais não são exibidas, mas estão disponíveis para Copilot permitir que ela gere respostas de maior qualidade.

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

Há três tipos principais de instruções personalizadas que você pode usar para personalizar Copilot respostas no GitHub site:

  •         **
            [Instruções pessoais](#about-personal-instructions)** se aplicam a todas as conversas que você tem com Chat Copilot no website GitHub. Elas permitem que você especifique suas preferências individuais, como idioma preferencial ou estilo de resposta, garantindo a adaptação das respostas às suas necessidades pessoais.
    
  •         **
            [As instruções personalizadas do repositório](#about-repository-custom-instructions)** se aplicam a conversas no contexto de um repositório específico. Eles são úteis para definir padrões, estruturas ou ferramentas de codificação específicas do projeto. Por exemplo, você pode especificar que um repositório usa TypeScript e uma biblioteca específica, garantindo respostas consistentes para todos os colaboradores.
    
  •         **
            [As instruções personalizadas da organização](#about-organization-custom-instructions)** se aplicam a conversas no contexto de uma organização no GitHub site. Elas são ideais para impor preferências em toda a organização, como uma linguagem comum ou diretrizes de segurança. As instruções personalizadas da organização só podem ser definidas pelos proprietários da organização para organizações com uma Copilot Business ou Copilot Enterprise assinatura.
    

Sobre instruções pessoais

Observação

As instruções personalizadas pessoais só são suportadas para Chat do GitHub Copilot no GitHub.

Você pode personalizar como Chat Copilot responde a você no GitHub.com adicionando instruções pessoais, que Copilot se aplicarão somente a você. Você faz isso em uma janela pop-up na Chat Copilot página em GitHub.com. Confira Adicionando instruções personalizadas pessoais para GitHub Copilot.

Sobre instruções personalizadas de repositório

Você pode usar três tipos de instruções personalizadas do repositório em CopilotGitHub.com:

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

Sobre instruções personalizadas da organização

Observação

          **Apoio:** No momento, as instruções personalizadas da organização só têm suporte para Chat Copilot on GitHub.com, Revisão de código com Copilot on GitHub.com e Agente de nuvem Copilot on GitHub.com.

Os proprietários da organização podem adicionar instruções para Copilot adaptar respostas às necessidades e preferências da sua organização. Por exemplo, você pode optar por sempre responder Copilot no idioma de sua empresa de escolha ou com um estilo específico.

Instruções personalizadas definidas nas configurações da organização Copilot são usadas para todos os membros da organização, independentemente de receberem a assinatura Copilot da organização.

Veja alguns exemplos de instruções que você pode adicionar:

  • Always respond in Spanish.
  • Do not generate code blocks in responses.
  • For questions related to security, use the Security Docs Knowledge Base.

Precedência de instruções personalizadas

Vários tipos de instruções personalizadas podem se aplicar a uma solicitação enviada ao Copilot. As instruções pessoais assumem a prioridade mais alta. As instruções do repositório vêm em seguida e, em seguida, as instruções da organização são priorizadas por último. No entanto, todas as instruções relevantes são fornecidas para Copilot.

A lista a seguir mostra a ordem de precedência completa, com instruções mais altas nesta lista tendo precedência sobre as mais baixas da lista:

  •         **Instruções pessoais**
    
  • Instruções personalizadas do repositório:
    • Instruções path-specific em qualquer arquivo .github/instructions/**/*.instructions.md aplicável
    •       **Instruções de todo o** repositório no `.github/copilot-instructions.md` arquivo
      
    •       **Instruções do agente** (por exemplo, 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 a instrução ao escolher se deseja adicionar uma instrução no nível pessoal, repositório ou organização.

Aqui estão alguns casos de uso comuns e exemplos para cada tipo de instruções personalizadas: * Instruções pessoais:

  • Idioma individual preferencial: Always respond in Portuguese.
  • Preferências de resposta individuais: Explain a single concept per line. Be clear and concise.
  •         **Instruções personalizadas do repositório:**
    
    • Padrões de codificação: Use early returns whenever possible.
    • Estruturas: Use Vue with the PrimeVue library. ou Use Typescript rather than Javascript.
    • Preferências de estilo de código: Use camel case for variable names.
  •         **Instruções personalizadas da organização:**
    
    • Descrever como responder a determinadas perguntas: For questions related to security, use the Security Docs Knowledge Base or advise people to consult with #security on Slack.
    • Idioma preferencial para uma empresa que fala exclusivamente um só idioma: Always respond in Portuguese.
    • Preferências em toda a organização: Do not generate code blocks in responses.

Observação

  • Revisão de código com Copilot lê apenas os primeiros 4.000 caracteres de qualquer arquivo de instruções personalizado. Quaisquer instruções além desse limite não afetarão as revisões geradas por Revisão de código com Copilot. Esse limite não se aplica a Chat Copilot ou Agente de nuvem Copilot.
  • Ao revisar uma solicitação de pull, o Copilot usa as instruções personalizadas na ramificação base da solicitação de pull. Por exemplo, se sua solicitação de pull busca mesclar my-feature-branch em main, o Copilot usará as instruções personalizadas em main.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo instruções personalizadas devem ser curtas e independentes para fornecer ao Copilot informações relevantes para ajudar a funcionar 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.
  • Inclua a estrutura de pastas do repositório, incluindo diretórios ou arquivos importantes relevantes para o projeto.
  • 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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

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

Próximas etapas

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)
    

Leitura adicional

  •         [AUTOTITLE](/copilot/concepts/agents/copilot-memory)
    
  •         [AUTOTITLE](/copilot/reference/customization-cheat-sheet)
    

Observação

Esta versão deste artigo é sobre instruções personalizadas e arquivos de prompt em VS Code. Clique nas guias acima para outros ambientes.

Sobre como personalizar Copilot respostas

          GitHub Copilot pode fornecer respostas adaptadas à maneira como sua equipe funciona, às ferramentas que você usa ou às especificidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos prompts, você pode criar arquivos em seu repositório que adicionam automaticamente essas informações para você.

Há dois tipos de arquivos que você pode usar para fornecer contexto e instruções para Copilot em VS Code:

  •         **As instruções personalizadas do repositório** permitem especificar instruções e preferências que Copilot serão consideradas ao trabalhar no contexto do repositório.
    
  •           Os **arquivos de prompt** (visualização pública) permitem que você salve instruções de prompt comuns e o contexto relevante em arquivos Markdown (`*.prompt.md`) que pode reutilizar em seus prompts de chat. Os arquivos de prompt só estão disponíveis em VS Code, Visual Studio e IDEs JetBrains.
    

Embora instruções personalizadas ajudem a adicionar contexto de toda a base de código a cada fluxo de trabalho de IA, os arquivos de prompt permitem adicionar instruções a uma interação de chat específica.

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.

Sobre instruções personalizadas de repositório

Você pode usar três tipos de instruções personalizadas do repositório em VS Code:

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

Sobre os arquivos de prompt

Observação

Os arquivos de prompt estão versão prévia pública sujeitos a alterações.

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 Chat Copilot (por exemplo, Rewrite #file:x.ts). Isso permite mesclar instruções em linguagem natural, contexto adicional e até mesmo vincular a outros arquivos de prompt como dependências.

Os casos de uso comuns incluem:

  •         **Geração de código**. Crie prompts reutilizáveis para componentes, testes ou migrações (por exemplo, formulários React ou objetos fictícios de API).
    
  •         **Especialista em domínio**. Compartilhe conhecimento especializado por meio de prompts, como práticas de segurança ou verificações de conformidade.
    
  •         **Colaboração de equipe**: Padrões e diretrizes de documentos com referências a especificações e documentação.
    
  •         **Integração**. Crie guias passo a passo para processos complexos ou padrões específicos de projeto.
    

Você pode ter vários arquivos de prompt em seu workspace, cada um deles define um prompt para uma finalidade diferente.

Exemplos

Os exemplos a seguir demonstram como usar esses arquivos de prompt.

  •         `New React form.prompt.md` – contém instruções para uma tarefa reutilizável para gerar um formulário usando o React.
    
    Your goal is to generate a new React form component.
    
    Ask for the form name and fields if not provided.
    
    Requirements for the form:
    - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
    - Use `react-hook-form` for form state management:
      - Always define TypeScript types for your form data
      - Prefer *uncontrolled* components using register
      - Use `defaultValues` to prevent unnecessary rerenders
    - Use `yup` for validation:
      - Create reusable validation schemas in separate files
      - Use TypeScript types to ensure type safety
      - Customize UX-friendly validation rules
    
  •         `API security review.prompt.md` - contém informações reutilizáveis sobre práticas de segurança para APIs REST, que podem ser usadas para realizar revisões de segurança de APIs REST.
    
    Secure REST API review:
    - Ensure all endpoints are protected by authentication and authorization
    - Validate all user inputs and sanitize data
    - Implement rate limiting and throttling
    - Implement logging and monitoring for security events
    …
    

Para obter informações sobre como habilitar, criar e usar arquivos de prompt, consulte Adicionando instruções personalizadas do repositório para GitHub Copilot.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo instruções personalizadas devem ser curtas e independentes para fornecer ao Copilot informações relevantes para ajudar a funcionar 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.
  • Inclua a estrutura de pastas do repositório, incluindo diretórios ou arquivos importantes relevantes para o projeto.
  • 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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

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

Próximas etapas

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
    
  •         [AUTOTITLE](/copilot/reference/customization-cheat-sheet)
    

Observação

Esta versão deste artigo é sobre instruções personalizadas e arquivos de prompt em Visual Studio. Clique nas guias acima para outros ambientes.

Sobre como personalizar Copilot respostas

          GitHub Copilot pode fornecer respostas adaptadas à maneira como sua equipe funciona, às ferramentas que você usa ou às especificidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos prompts, você pode criar arquivos em seu repositório que adicionam automaticamente essas informações para você.

Há dois tipos de arquivos que você pode usar para fornecer contexto e instruções para o Copilot em Visual Studio:

  •         **As instruções personalizadas do repositório** permitem especificar instruções e preferências que Copilot serão consideradas ao trabalhar no contexto do repositório.
    
  •         **Os arquivos de prompt** permitem que você salve instruções de prompt comuns e contexto relevante em arquivos markdown (`*.prompt.md`) que você pode reutilizar em seus prompts de chat. Os arquivos de prompt só estão disponíveis em VS Code, Visual Studio e IDEs JetBrains.
    

Embora instruções personalizadas ajudem a adicionar contexto de toda a base de código a cada fluxo de trabalho de IA, os arquivos de prompt permitem adicionar instruções a uma interação de chat específica.

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.

Sobre instruções personalizadas de repositório

Você pode usar dois tipos de instruções personalizadas do repositório em Visual Studio:

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

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

    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.

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

Para uma coleção de exemplos com curadoria, consulte Instruções personalizadas.

Sobre os arquivos de prompt

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 workspace, que imita o formato existente de gravação de prompts em Chat Copilot (por exemplo, Rewrite #file:x.ts). Isso permite mesclar instruções em linguagem natural, contexto adicional e até mesmo vincular a outros arquivos de prompt como dependências.

Os casos de uso comuns incluem:

  •         **Geração de código**. Crie prompts reutilizáveis para componentes, testes ou migrações (por exemplo, formulários React ou objetos fictícios de API).
    
  •         **Especialista em domínio**. Compartilhe conhecimento especializado por meio de prompts, como práticas de segurança ou verificações de conformidade.
    
  •         **Colaboração de equipe**: Padrões e diretrizes de documentos com referências a especificações e documentação.
    
  •         **Integração**. Crie guias passo a passo para processos complexos ou padrões específicos de projeto.
    

Você pode ter vários arquivos de prompt em seu workspace, cada um deles define um prompt para uma finalidade diferente.

Exemplos

Os exemplos a seguir demonstram como usar esses arquivos de prompt.

  •         `New React form.prompt.md` – contém instruções para uma tarefa reutilizável para gerar um formulário usando o React.
    
    Your goal is to generate a new React form component.
    
    Ask for the form name and fields if not provided.
    
    Requirements for the form:
    - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
    - Use `react-hook-form` for form state management:
      - Always define TypeScript types for your form data
      - Prefer *uncontrolled* components using register
      - Use `defaultValues` to prevent unnecessary rerenders
    - Use `yup` for validation:
      - Create reusable validation schemas in separate files
      - Use TypeScript types to ensure type safety
      - Customize UX-friendly validation rules
    
  •         `API security review.prompt.md` - contém informações reutilizáveis sobre práticas de segurança para APIs REST, que podem ser usadas para realizar revisões de segurança de APIs REST.
    
    Secure REST API review:
    - Ensure all endpoints are protected by authentication and authorization
    - Validate all user inputs and sanitize data
    - Implement rate limiting and throttling
    - Implement logging and monitoring for security events
    …
    

Para obter informações sobre como criar e usar arquivos de prompt, consulte Adicionando instruções personalizadas do repositório para GitHub Copilot.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo instruções personalizadas devem ser curtas e independentes para fornecer ao Copilot informações relevantes para ajudar a funcionar 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.
  • Inclua a estrutura de pastas do repositório, incluindo diretórios ou arquivos importantes relevantes para o projeto.
  • 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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

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

Próximas etapas

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/reference/customization-cheat-sheet)
    

Observação

Esta versão deste artigo é sobre instruções personalizadas e arquivos de prompt em IDEs do JetBrains. Clique nas guias acima para outros ambientes.

Sobre como personalizar Copilot respostas

          GitHub Copilot pode fornecer respostas adaptadas à maneira como sua equipe funciona, às ferramentas que você usa ou às especificidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos seus prompts, você pode criar um arquivo de instruções personalizado em seu repositório que adiciona automaticamente essas informações para você.

Há dois tipos de arquivos que você pode usar para fornecer contexto e instruções em Copilot IDEs do JetBrains:

  •         **As instruções personalizadas do repositório** permitem especificar instruções e preferências que Copilot serão consideradas ao trabalhar no contexto do repositório.
    
  •           Os **arquivos de prompt** (visualização pública) permitem que você salve instruções de prompt comuns e o contexto relevante em arquivos Markdown (`*.prompt.md`) que pode reutilizar em seus prompts de chat. Os arquivos de prompt só estão disponíveis em VS Code, Visual Studio e IDEs JetBrains.
    

Embora instruções personalizadas ajudem a adicionar contexto de toda a base de código a cada fluxo de trabalho de IA, os arquivos de prompt permitem adicionar instruções a uma interação de chat específica.

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.

Sobre instruções personalizadas de repositório

Nos IDEs do JetBrains, as instruções personalizadas do repositório consistem em um único arquivo, .github/copilot-instructions.md, que você cria em um repositório. As instruções que você adiciona ao arquivo devem ser curtas e autossuficientes, de forma a adicionar contexto ou informações relevantes para complementar um Copilot prompt.

Suporte para instruções personalizadas de repositório

Para obter detalhes sobre quais tipos de instruções personalizadas têm suporte em vários ambientes, consulte Suporte para diferentes tipos de instruções personalizadas.

Casos de uso para instruções personalizadas

Casos de uso comuns para instruções personalizadas incluem:

  •         **Geração de teste.** Crie instruções para a geração de teste, como especificar o uso de uma determinada estrutura de teste.
    
  •         **Revisão de código.** Especifique instruções para revisar o código, como pedir a um revisor para procurar um erro específico no código.
    
  •         **Geração de mensagem do commit.** Escreva instruções para gerar mensagens de confirmação, como formato ou o tipo de informação a ser incluída.
    

Exemplo

Este exemplo de um arquivo .github/copilot-instructions.md contém três instruções para o Copilot.

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.

Para uma coleção de exemplos com curadoria, consulte Instruções personalizadas.

Sobre os arquivos de prompt

Observação

Os arquivos de prompt estão versão prévia pública e sujeitos a alterações.

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 escrita de avisos em Chat Copilot (por exemplo, Rewrite #file:x.ts). Isso permite a combinação de instruções de linguagem natural e contexto adicional.

Os casos de uso comuns incluem:

  •         **Geração de código**. Crie prompts reutilizáveis para componentes, testes ou migrações (por exemplo, formulários React ou objetos fictícios de API).
    
  •         **Especialista em domínio**. Compartilhe conhecimento especializado por meio de prompts, como práticas de segurança ou verificações de conformidade.
    
  •         **Colaboração de equipe**: Padrões e diretrizes de documentos com referências a especificações e documentação.
    
  •         **Integração**. Crie guias passo a passo para processos complexos ou padrões específicos de projeto.
    

Você pode ter vários arquivos de prompt em seu workspace, cada um deles define um prompt para uma finalidade diferente.

Exemplos

Os exemplos a seguir demonstram como usar esses arquivos de prompt.

  •         `New React form.prompt.md` – contém instruções para uma tarefa reutilizável para gerar um formulário usando o React.
    
    Your goal is to generate a new React form component.
    
    Ask for the form name and fields if not provided.
    
    Requirements for the form:
    - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
    - Use `react-hook-form` for form state management:
      - Always define TypeScript types for your form data
      - Prefer *uncontrolled* components using register
      - Use `defaultValues` to prevent unnecessary rerenders
    - Use `yup` for validation:
      - Create reusable validation schemas in separate files
      - Use TypeScript types to ensure type safety
      - Customize UX-friendly validation rules
    
  •         `API security review.prompt.md` - contém informações reutilizáveis sobre práticas de segurança para APIs REST, que podem ser usadas para realizar revisões de segurança de APIs REST.
    
    Secure REST API review:
    - Ensure all endpoints are protected by authentication and authorization
    - Validate all user inputs and sanitize data
    - Implement rate limiting and throttling
    - Implement logging and monitoring for security events
    …
    

Para uma coleção de exemplos com curadoria, consulte Arquivos de prompt.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo instruções personalizadas devem ser curtas e independentes para fornecer ao Copilot informações relevantes para ajudar a funcionar 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.
  • Inclua a estrutura de pastas do repositório, incluindo diretórios ou arquivos importantes relevantes para o projeto.
  • 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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

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

Próximas etapas

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
    
  •         [AUTOTITLE](/copilot/reference/customization-cheat-sheet)
    

Observação

Esta versão deste artigo é sobre instruções personalizadas no Xcode. Clique nas guias acima para outros ambientes.

Sobre como personalizar Copilot respostas

          GitHub Copilot pode fornecer respostas adaptadas à maneira como sua equipe funciona, às ferramentas que você usa ou às especificidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos seus prompts, você pode criar um arquivo de instruções personalizado em seu repositório que adiciona automaticamente essas informações para você. As informações adicionais não são exibidas na caixa de entrada do chat, mas estão disponíveis para que Copilot possa gerar respostas de maior qualidade.

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.

Sobre instruções personalizadas de repositório

No Xcode, as instruções personalizadas do repositório consistem em um único arquivo, .github/copilot-instructions.md, que você cria em um repositório. As instruções que você adicionar ao arquivo devem ser curtas e autoexplicativas, acrescentando contexto ou informações relevantes para complementar um Copilot prompt.

Suporte para instruções personalizadas de repositório

Para obter detalhes sobre quais tipos de instruções personalizadas têm suporte em vários ambientes, consulte Suporte para diferentes tipos de instruções personalizadas.

Casos de uso para instruções personalizadas

Casos de uso comuns para instruções personalizadas do repositório incluem:

  •         **Geração de teste.** Crie instruções para a geração de teste, como especificar o uso de uma determinada estrutura de teste.
    
  •         **Revisão de código.** Especifique instruções para revisar o código, como pedir a um revisor para procurar um erro específico no código.
    
  •         **Geração de mensagem do commit.** Escreva instruções para gerar mensagens de confirmação, como formato ou o tipo de informação a ser incluída.
    

Exemplo

Este exemplo de um arquivo .github/copilot-instructions.md contém três instruções para o Copilot.

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.

Para uma coleção de exemplos com curadoria, consulte Instruções personalizadas.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo instruções personalizadas devem ser curtas e independentes para fornecer ao Copilot informações relevantes para ajudar a funcionar 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.
  • Inclua a estrutura de pastas do repositório, incluindo diretórios ou arquivos importantes relevantes para o projeto.
  • 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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

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

Próximas etapas

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
    
  •         [AUTOTITLE](/copilot/reference/customization-cheat-sheet)
    

Observação

Esta versão deste artigo é sobre instruções personalizadas no Eclipse. Clique nas guias acima para outros ambientes.

Sobre como personalizar Copilot respostas

          GitHub Copilot pode fornecer respostas adaptadas à maneira como sua equipe funciona, às ferramentas que você usa ou às especificidades do seu projeto, se você fornecer contexto suficiente para isso. Em vez de adicionar repetidamente esse detalhe contextual aos seus prompts, você pode criar um arquivo de instruções personalizado em seu repositório que adiciona automaticamente essas informações para você. As informações adicionais não são exibidas na caixa de entrada de chat, mas estão disponíveis para Copilot permitir que ela gere respostas de maior qualidade.

Existem dois tipos de instruções personalizadas de repositório que você pode usar para fornecer contexto e instruções a Copilot no Eclipse:

  •         **Instruções personalizadas do workspace** que se aplicam a todos os projetos em um workspace e permitem que você especifique instruções e preferências em todo o workspace em um só arquivo.
    
  •         **Instruções personalizadas do projeto** que se aplicam a um projeto específico.
    

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.

Sobre instruções personalizadas de repositório

          As **instruções personalizadas do workspace** se aplicam a todos os projetos em um workspace e permitem que você especifique instruções e preferências em todo o workspace. Você pode usar instruções personalizadas de área de trabalho para fornecer contexto e instruções ao Copilot no Eclipse.

          **Instruções personalizadas do projeto** consistem em um único arquivo, `.github/copilot-instructions.md`, que você cria em um projeto. As instruções que você acrescenta ao arquivo devem ser curtas e auto-suficientes, adicionando contexto ou informações relevantes para complementar um Copilot prompt.

Os casos de uso comuns incluem:

  •         **Geração de teste.** Crie instruções para a geração de teste, como especificar o uso de uma determinada estrutura de teste.
    
  •         **Revisão de código.** Especifique instruções para revisar o código, como pedir a um revisor para procurar um erro específico no código.
    
  •         **Geração de mensagem do commit.** Escreva instruções para gerar mensagens de confirmação, como formato ou o tipo de informação a ser incluída.
    

Exemplo

Este exemplo de um arquivo .github/copilot-instructions.md contém três instruções para o Copilot.

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.

Para uma coleção de exemplos com curadoria, consulte Instruções personalizadas.

Como escrever instruções personalizadas eficazes

As instruções que você adiciona ao arquivo instruções personalizadas devem ser curtas e independentes para fornecer ao Copilot informações relevantes para ajudar a funcionar 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.
  • Inclua a estrutura de pastas do repositório, incluindo diretórios ou arquivos importantes relevantes para o projeto.
  • 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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

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

Próximas etapas

  •         [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [AUTOTITLE](/copilot/tutorials/use-custom-instructions)
    
  •         [AUTOTITLE](/copilot/reference/customization-cheat-sheet)