🤖 GitHub复制品资产库
通过全面的说明、提示、聊天模式和配置来增强您的GitHub Copilot体验。在开发、架构、规划和文档任务中,获得符合团队编码标准和项目要求的一致人工智能协助。
GitHub Copilot不仅可以帮助你完成编码任务,还可以帮助你思考、解决问题、理解、规划、研究等等。
最大的挑战是创建或找到正确的提示和工具,以充分利用GitHub Copilot,以及何时使用它们。
我花了很多时间构建自己的工具、提示和聊天模式来帮助我完成工作,我想与大家分享。
\[!注意\] 我创建了这个仓库,却不知道GitHub团队计划发布一个类似的库 然而,我计划将来将此存储库中的所有资源迁移到Github Awesome Copilot存储库。因此,您将开始在两个存储库中看到重复的内容。 我正在考虑保留这个存储库,以增强它,在每种聊天模式上都有更详细的页面,提示文件显示了使用示例。因为这些模式的可能性通常需要更详细的检查和演示。
🎯 GitHub Copilot自定义功能
GitHub Copilot提供多种方式来定制AI响应,并根据您的特定工作流程、团队指南和项目要求量身定制帮助:
| 🔧 客户指令 | 📝 提示文件(可重复使用的提示) | 🧩 自定义聊天模式 | 🔌 MCP服务器 |
|---|---|---|---|
| 为代码生成、审查和提交消息等任务定义通用准则。描述 *如何* 应执行任务 |
优点: •自动包含在每个聊天请求中 •整个存储库的一致性 •多种实现选项|为特定任务创建可重用的独立提示。描述 *什么* 应使用可选的任务特定指南来完成
优点: •消除重复的提示写作 •可跨团队共享 •支持变量和依赖关系|为每个请求定义特定边界内的聊天行为、可用工具和代码库交互模式
优点: •情境感知协助 •工具配置 •特定角色的工作流程|通过模型上下文协议使用标准化的工具、资源和提示扩展GitHub Copilot代理,以执行专门的任务和外部集成
优点: •调用数据库、API和文件操作工具 •访问外部资源作为聊天上下文 •复杂工作流程的预配置提示 •工具确认和参数编辑 •自动发现和工作空间共享|
💡 专业提示: 自定义指令仅影响Copilot Chat(不影响内联代码完成)。您可以组合所有三种自定义类型-使用自定义指令作为一般准则,使用提示文件进行特定任务,以及使用聊天模式来控制交互上下文。
目录
- 📋 自定义指令文件 - 📝 提示文件(可重复使用的提示) - 🧩 自定义聊天模式 - 🔌 MCP服务器
复制品特征库
📋 自定义指令文件
具有特定语言和框架指导的自定义指令文件可以在 instructions/ 文件夹。
\[!重要\] 自定义说明仅适用于聊天模式(询问、编辑、代理或自定义模式),不适用于编辑器中的复制自动完成。
| 标题 | 描述 | 安装 |
|---|
工作区使用中的自定义指令文件
要在存储库中设置自定义指令文件,请执行以下操作:
- 将这些说明复制到您的
.github/copilot-instructions.md文件或创建特定任务.github/.instructions.md工作区中的文件.github/instructions文件夹。
当所有贡献者在指定的文件类型(例如C#文件)中使用GitHub Copilot时,此文件将自动应用于他们。
📝 提示文件(可重复使用的提示)
提示文件示例见 prompts/ 文件夹。
| 标题 | 描述 | 安装 |
|---|
提示工作区中的文件使用情况
要使用提示文件,请执行以下操作:
- 从复制
prompts将此存储库中的文件夹添加到您的工作区或用户.vscode/prompts/文件夹。
- 使用
@在VS Code聊天中,选择您的提示,或运行Chat: Run Prompt命令。
Run a custom prompt file in Visual Studio Code
🧩 自定义聊天模式
自定义聊天模式为GitHub Copilot chat定义了特定的行为和工具,为特定任务或工作流提供了增强的上下文感知帮助。
聊天模式示例见 chatmodes/ 文件夹。
| 标题 | 描述 | 安装 |
|---|
工作区使用中的自定义聊天模式
要使用聊天模式,请执行以下操作:
- 从复制
chatmodes将此存储库中的文件夹添加到您的工作区或用户.vscode/chatmodes/文件夹。
- 在VS Code中,从聊天模式下拉列表中选择您的自定义聊天模式。
Select a custom chat mode in Visual Studio Code
🔌 MCP服务器
MCP(模型上下文协议)服务器配置示例可以在 mcp/ 文件夹。
MCP服务器通过外部工具、资源和专门任务的提示来扩展GitHub Copilot代理。
资产类型概述
| 资产类型 | 描述 | 可用性 | 配置 |
|---|---|---|---|
| 客户指令 | 适用于文件类型(例如C#文件)的特定语言指南 | VS代码和VS | 用户和工作区 |
| 提示文件 | 特定任务的可重用、独立提示,带有可选变量 | 仅VS代码 | 用户和工作区 |
| 自定义聊天模式 | 专用工作流和上下文的预定义说明和工具 | 仅VS代码 | 用户和工作区 |
| MCP服务器 | 通过模型上下文协议进行外部服务集成,以增强功能 | VS代码和VS | 用户和工作区 |
副驾驶特征对比表
| 功能名称 | 描述 | VS代码/VS支持 | 配置级别 |
|---|---|---|---|
| 自定义代码生成说明 | 代码生成说明 用于代码生成任务。 | 仅VS代码 | 用户和工作区 |
| 提示文件 | 提示文件 是常见任务的可重用提示。 | 仅VS代码 | 用户和工作区 |
| 自定义聊天模式 | 自定义聊天模式 结合特定工作流程的说明和工具。 | 仅VS代码 | 用户和工作区 |
| MCP服务器 | MCP服务器 使Copilot能够通过模型上下文协议调用外部服务。 | VS代码和VS | 用户和工作区 |
📚 其他资源
- VS代码副本定制文档 -微软官方文档
- -完整的聊天功能指南
- 自定义聊天模式 -高级聊天配置
- VS代码设置 -通用VS代码配置指南
🛠️ 开发配置
此存储库使用各种配置文件来确保代码风格的一致性,并避免行尾问题:
.editorconfig-定义跨不同编辑器和IDE的编码样式.gitattributes-确保文本文件中的行尾一致.vscode/settings.json-VS此存储库的特定代码设置.vscode/extensions.json-推荐的VS代码扩展名
💡 备注:此存储库中的所有markdown文件都使用LF行尾(Unix风格),以避免混合行尾问题。存储库配置为自动处理行尾转换。
📄 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
🤝 行为准则
请注意,此项目随附 贡献者行为准则参与此项目即表示您同意遵守其条款。
™️ 商标
此项目可能包含项目、产品或服务的商标或徽标。授权使用Microsoft 商标或徽标必须遵守 微软商标和品牌指南. 在本项目的修改版本中使用Microsoft商标或徽标不得造成混淆或暗示Microsoft赞助。 任何使用第三方商标或徽标的行为均受这些第三方政策的约束。
