Configuring coding guidelines for GitHub Copilot code review

Learn how to customize Copilot 代码评审 with custom coding guidelines.

本文内容

注意

自定义编码准则功能仅适用于 Copilot Enterprise 计划，目前仅限选定客户使用。 See Adding repository custom instructions for GitHub Copilot.

About coding guidelines

You can provide Copilot with a set of coding guidelines, written in natural language, that will help it review your code in a way that aligns with your organization's coding style and best practices. For more information—including examples of coding guidelines—see About coding guidelines for GitHub Copilot code review.

Creating a coding guideline

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在存储库名称下，单击 “设置”。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. In the "Code & automation" section of the sidebar, click Copilot, then Code review.

  4. Click Create guideline.

  5. Under "Name," give the coding guideline a name.

  6. Under "Description," provide a description of the coding guideline up to 600 characters long. This will be used by Copilot to understand your coding style and to decide when to leave a comment.

    How you write your description has a big impact on the quality of comments that Copilot will generate. For help with writing effective coding guidelines, see About coding guidelines for GitHub Copilot code review.

  7. Optionally, limit the coding guideline to specific file types or paths by clicking Add file path and adding path patterns.

    You can use fnmatch syntax to define paths to target, with * as a wildcard to match any string of characters.

    由于 GitHub 对 File.fnmatch 语法使用 File::FNM_PATHNAME 标记，因此 * 通配符与目录分隔符 (/) 不匹配。 例如，qa/* 将匹配以 qa/ 开头并包含单个斜杠的所有分支，但不会匹配 qa/foo/bar。 可以使用 qa/**/* 在 qa 后面包含任意数量的斜杠，这将匹配 qa/foo/bar/foobar/hello-world。 还可以使用 qa**/**/* 扩展 qa 字符串，以使规则更具包容性。

    有关语法选项的详细信息，请参阅 fnmatch 文档。

  8. Test your coding guideline to make sure it works as expected.

    1. Click Add sample.
    2. Add your own sample, or press Generate code sample to automatically generate a code sample based on your title and description.
    3. Click Save to save the code sample.
    4. Test the coding guideline against your sample by pressing Run.

  9. Save your coding guideline, and turn it on, by clicking Save guideline.