关于自定义 GitHub Copilot 响应

关于自定义 Copilot 响应

如果您为 GitHub Copilot 提供足够的上下文，它便可提供根据您的团队工作方式、所用工具或项目特定要求量身定制的响应。您无需反复将此上下文详细信息添加到提示中，而是可以在仓库中创建自定义指令文件，Copilot 会自动为您添加此信息。

您可以使用两种类型的文件来在 JetBrains IDE 中向 Copilot 提供上下文和指令

• 仓库自定义指令允许您指定 Copilot 在仓库上下文中工作时会考虑的指令和偏好。
• 提示文件（公开预览版）允许您将常见的提示指令和相关上下文保存在 Markdown 文件（*.prompt.md）中，然后可以在聊天提示中重用。提示文件仅在 VS Code、Visual Studio 和 JetBrains IDE 中可用。

虽然自定义指令有助于为每个 AI 工作流添加代码库范围的上下文，但提示文件允许您向特定的聊天交互添加指令。

关于仓库自定义指令

在 JetBrains IDE 中，仓库自定义指令由您在仓库中创建的单个文件 `.github/copilot-instructions.md` 组成。您添加到文件中的指令应该是简短、独立的语句，用于添加上下文或相关信息以补充 Copilot 提示。

对仓库自定义指令的支持

有关在各种环境中支持哪些类型自定义指令的详细信息，请参阅对不同类型自定义指令的支持。

自定义指令的用例

自定义指令的常见用例包括

• 测试生成。创建测试生成指令，例如指定使用某个测试框架。
• 代码审查。指定代码审查指令，例如告诉审查员查找代码中的特定错误。
• 提交消息生成。编写生成提交消息的指令，例如格式或要包含的信息类型。

示例

此 `.github/copilot-instructions.md` 文件示例包含 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.

有关精选示例集合，请参阅自定义指令。

关于提示文件

提示文件允许您构建和共享具有附加上下文的可重用提示指令。提示文件是存储在工作区中的 Markdown 文件，它模仿 Copilot Chat 中编写提示的现有格式（例如，`Rewrite #file:x.ts`）。这允许混合自然语言指令和附加上下文。

常见用例包括

• 代码生成。为组件、测试或迁移创建可重用提示（例如，React 表单或 API 模拟）。
• 领域专业知识。通过提示共享专业知识，例如安全实践或合规性检查。
• 团队协作。使用规范和文档参考来记录模式和指南。
• 入职培训。为复杂流程或项目特定模式创建分步指南。

您的工作区中可以有多个提示文件，每个文件都为不同的目的定义一个提示。

示例

以下示例演示如何使用提示文件。

• New React form.prompt.md - 包含用于生成 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 - 包含有关 REST API 安全实践的可重用信息，可用于对 REST API 进行安全审查。

  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
  …
  

有关精选示例集合，请参阅提示文件。

编写有效的自定义指令

您添加到自定义指令文件中的指令应该是简短、独立的语句，为 Copilot 提供相关信息以帮助它在此仓库中工作。由于指令随每条聊天消息发送，因此它们应广泛适用于您在仓库上下文中发出的大多数请求。

您用于指令文件的确切结构将因项目和需求而异，但以下准则提供了一个很好的起点

• 提供您正在处理的项目的概述，包括其目的、目标和任何相关的背景信息。
• 包括仓库的文件夹结构，包括与项目相关的任何重要目录或文件。
• 指定应遵循的编码标准和约定，例如命名约定、格式规则和最佳实践。
• 包含项目中使用的任何特定工具、库或框架，以及任何相关的版本号或配置。

以下指令文件是这些实践的一个示例

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

您还应考虑仓库的大小和复杂性。以下类型的指令可能适用于只有少数贡献者的小型仓库，但对于大型且多样化的仓库，这些可能会导致问题

• 在制定响应时引用外部资源的请求
• 以特定样式回答的指令
• 请求始终以某种详细程度进行响应

例如，以下指令可能无法达到预期效果

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.

后续步骤

• 为 GitHub Copilot 添加仓库自定义指令
• 使用自定义指令解锁 Copilot 代码审查的强大功能
• Copilot 自定义备忘单