3.9 KiB
title, shortTitle, allowTitleToDifferFromFilename, intro, versions, topics, contentType
| title | shortTitle | allowTitleToDifferFromFilename | intro | versions | topics | contentType | |||
|---|---|---|---|---|---|---|---|---|---|
| About coding guidelines for GitHub Copilot code review | Coding guidelines | true | Find out how you can use custom coding guidelines to improve {% data variables.product.prodname_copilot_short %}'s pull request reviews. |
|
|
concepts |
{% data reusables.copilot.code-review.custom-coding-guidelines-prerequisites %} See AUTOTITLE.
About coding guidelines
You can customize {% data variables.copilot.copilot_code-review_short %} with custom coding guidelines written in natural language. For more information on {% data variables.copilot.copilot_code-review_short %}, see AUTOTITLE.
With coding guidelines, {% data variables.product.prodname_copilot_short %} can give feedback based on your organization's specific coding style and best practices.
Because {% data variables.copilot.copilot_code-review_short %} is powered by a large language model, it can help with enforcing coding guidelines that are not covered by your linter or static analysis tool.
Coding guidelines are configured at the repository level. You can create and enable up to 6 coding guidelines per repository. See AUTOTITLE.
When you request a review from {% data variables.product.prodname_copilot_short %}, it will automatically use the repository's enabled coding guidelines to review your code.
Comments generated based on a coding guideline will include a message, highlighting their source.
[!NOTE] Coding guidelines only apply to code reviews carried out by Copilot. The guidelines do not affect Copilot code completion suggestions, or code suggested in Copilot Chat responses.
Dos and don'ts for coding guidelines
- Do use simple, clear and concise language to describe your coding guideline.
- Do be as specific as possible about what Copilot should look for - that is, what you do or don't want to see in your code.
- Do take a look at the Coding guidelines examples below for some inspiration.
- Don't try to use coding guidelines to enforce style guidelines that can be covered by your linter or static analysis tool.
- Don't use wording that is ambiguous or could be interpreted in different ways.
- Don't try to fit multiple different ideas into a single coding guideline.
Coding guidelines examples
Example 1: Avoid using magic numbers
Title: Avoid using magic numbers
Description: Don't use magic numbers in code. Numbers should be defined as constants or variables with meaningful names.
Path patterns: **/*.py
Example 2: Don't use SELECT * in SQL queries
Title: Don't use `SELECT *` in SQL queries
Description: Don't use `SELECT *` in SQL queries. Always specify the columns you want to select. `COUNT(*)` is allowed.
Path patterns: None (applies to all file types, as SQL queries may be embedded in code).
Example 3: Use fetch for HTTP requests
Title: Use `fetch` for HTTP requests
Description: Use `fetch` for HTTP requests, not `axios` or `superagent` or other libraries.
Path patterns: **/*.ts, **/*.js, **/*.jsx, **/*.tsx
Example 4: Always tag metrics with the current environment
Title: Always tag metrics with the current environment
Description: Always include a `env` tag with the current environment when emitting metrics, for example, `env:prod` or `env:dev`.
Path patterns: */*.go, */*.java