Skip to main content
Skip to content

GitHub Copilot 的提示文件

在可重用的 Markdown 提示文件中保存特定于任务的说明和上下文,以便进行单独的 Copilot 交互。

提示文件是可重用的独立 Markdown 模板,用于集中 Copilot 交互。 它们可以包含输入变量和其他上下文,以便可以重复使用具有不同输入的提示。 存储库提示文件使用 .prompt.md 扩展名,通常存储在 .github/prompts/. Visual Studio Code 和 JetBrains IDEs 还允许您配置其他位置。

与自定义说明不同,自定义说明会在其定义的范围内自动提供上下文,而提示文件则是为特定交互调用的。 在受支持的 IDE 中,可以在聊天中通过引用或选择它来运行其中一个。

按 IDE 和版本提供的提示文件支持

提示文件可在 Visual Studio、JetBrains IDEs、Visual Studio Code 和 Xcode 中使用。 有关当前支持和特定于 IDE 和版本的可用性,请参阅 Copilot自定义备忘单 和 Copilot特征矩阵。

Examples

生成 React 窗体

以下 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

查看 REST API 安全性

以下 API security review.prompt.md 文件包含用于审查 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
…