Como configurar diretrizes de codificação para a revisão de código do GitHub Copilot

Saiba como personalizar a Revisão de código do Copilot com diretrizes de codificação personalizadas.

Neste artigo

Observação

O recurso de diretrizes de codificação personalizadas só está disponível com o plano do Copilot Enterprise e, atualmente, está limitado a clientes selecionados.

Esse recurso será preterido em favor do uso de instruções personalizadas do Copilot para personalizar o Revisão de código do Copilot. Confira Como adicionar instruções personalizadas de repositório no GitHub Copilot.

Sobre as diretrizes de codificação

Você pode fornecer ao Copilot um conjunto de diretrizes de codificação, escritas em linguagem natural, que ajudarão a revisar seu código de uma forma que se alinhe ao estilo de codificação e às práticas recomendadas da sua organização. Para obter mais informações, incluindo exemplos de diretrizes de codificação, consulte Sobre diretrizes de codificação para a revisão do GitHub Copilot.

Como criar uma diretriz de codificação

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

  2. Abaixo do nome do repositório, clique em Configurações. 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. Selecione Criar diretriz.

  5. Em “Nome”, dê um nome à diretriz de codificação.

  6. Em “Descrição”, forneça uma descrição da diretriz de codificação de até 600 caracteres. Isso será usado pelo Copilot para entender seu estilo de codificação e decidir quando deixar um comentário.

    A forma como você escreve a descrição tem um grande impacto na qualidade dos comentários que serão gerados pelo Copilot. Para obter ajuda para escrecer diretrizes de codificação eficazes, consulte Sobre diretrizes de codificação para a revisão do GitHub Copilot.

  7. Opcionalmente, limite a diretriz de codificação a tipos de arquivo ou caminhos específicos selecionando Adicionar caminho de arquivo e adicionando padrões de caminho.

    Você pode usar a sintaxe fnmatch para definir os caminhos de destino, com * como um curinga para corresponder a qualquer cadeia de caracteres.

    Como o GitHub usa o sinalizador File::FNM_PATHNAME para a sintaxe File.fnmatch, o curinga * não corresponde aos separadores de diretório (/). Por exemplo, qa/* corresponderá a todos os branches que começam com qa/ e que contêm uma barra "/", mas não corresponderá a qa/foo/bar. Você pode incluir qualquer quantidade de barras "/" após qa com qa/**/*, o que corresponderá, por exemplo, a qa/foo/bar/foobar/hello-world. Você também pode estender a cadeia de caracteres qa com qa**/**/* para tornar a regra mais inclusiva.

    Para obter mais informações sobre as opções de sintaxe, confira a documentação de fnmatch.

  8. Teste a diretriz de codificação para verificar se ela funciona conforme o esperado.

    1. Selecione Adicionar amostra.
    2. Adicione a sua amostra ou pressione Generate code sample para gerar automaticamente uma amostra de código conforme o título e a descrição.
    3. Selecione Salvar para salvar o código de exemplo.
    4. Teste a diretriz de codificação em relação à sua amostra pressionando Run.

  9. Salve a diretriz de codificação e ative-a selecionando Salvar diretriz.