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 personalizar a Revisão de código do Copilot com diretrizes de codificação personalizadas escritas em linguagem natural. Para obter mais informações sobre a Revisão de código do Copilot, confira Sobre a revisão do Copilot.
Com as diretrizes de codificação, o Copilot pode fornecer comentários com base no estilo de codificação e nas melhores práticas específicas da sua organização.
Como a Revisão de código do Copilot é alimentada por um grande modelo de linguagem, ela pode ajudar na imposição de diretrizes de codificação que não são cobertas pela sua ferramenta de análise estática ou pelo linter.
As diretrizes de codificação são configuradas no repositório. Você pode criar e habilitar até seis diretrizes de codificação por repositório. Confira Configuring coding guidelines for GitHub Copilot code review.
Quando você solicita uma revisão do Copilot, ele usará automaticamente as diretrizes de codificação habilitadas do repositório para revisar seu código.
Os comentários gerados com base em uma diretriz de codificação incluirão uma mensagem, realçando a origem dela.
Observação
As diretrizes de codificação só se aplicam às revisões de código realizadas pelo Copilot. As diretrizes não afetam as sugestões de preenchimento de código do Copilot nem o código sugerido nas respostas do Chat do Copilot.
Recomendações para as diretrizes de codificação
- Use uma linguagem simples, clara e concisa para descrever a diretriz de codificação.
- Seja o mais específico possível sobre o que Copilot deve procurar – ou seja, o que você quer ou não quer ver no código.
- Confira os Exemplos de diretrizes de codificação abaixo para ter inspiração.
- Não tente usar diretrizes de codificação para impor diretrizes de estilo que podem ser tratadas pela ferramenta de análise estática ou pelo linter.
- Não use palavras ambíguas ou que possam ser interpretadas de maneiras diferentes.
- Não tente colocar várias ideias diferentes em uma só diretriz de codificação.
Exemplos de diretrizes de codificação
Exemplo 1: evite usar números mágicos
Título: Avoid using magic numbers
Descrição: Don't use magic numbers in code. Numbers should be defined as constants or variables with meaningful names.
Padrões de caminho: **/*.py
Exemplo 2: não use SELECT * em consultas SQL
Título: Don't use `SELECT *` in SQL queries
Descrição: Don't use `SELECT *` in SQL queries. Always specify the columns you want to select. `COUNT(*)` is allowed.
Padrões de caminho: nenhum (aplica-se a todos os tipos de arquivo, pois as consultas SQL podem ser inseridas no código).
Exemplo 3: use fetch para solicitações HTTP
Título: Use `fetch` for HTTP requests
Descrição: Use `fetch` for HTTP requests, not `axios` or `superagent` or other libraries.
Padrões de caminho: **/*.ts, **/*.js, **/*.jsx, **/*.tsx
Exemplo 4: sempre adicione tags às métricas com o ambiente atual
Título: Always tag metrics with the current environment
Descrição: Always include a `env` tag with the current environment when emitting metrics, for example, `env:prod` or `env:dev`.
Padrões de caminho: */*.go, */*.java