可复用的 GitHub Copilot Prompt 用于实现计划

Source: Dev.to

介绍

GitHub Copilot Agent 生成的大幅编辑可能会让人感到风险较大。
一个小的、可复用的提示文件可以通过强制代理在进行任何更改之前先生成详细的实现计划来降低风险。

设置

1. 在你的仓库中，如果尚不存在，创建一个名为 .github/prompts 的文件夹。
2. 在该文件夹内添加一个名为 implementation_plan.prompt.md 的文件。

提示文件内容

---
agent: agent
---
Before making any changes, prepare a detailed step‑by‑step implementation plan with numbered actions, files to edit, reasoning for each change, identified risks, and example code snippets for key parts. Ask clarifying questions if anything in my request is unclear. Present this plan for review and wait for my approval before starting.

前置元数据选择将运行此提示的代理。指令要求代理提供具体的要素，如有序步骤、目标文件、理由、风险说明以及关键部分的小代码示例。它还规定代理在编辑前必须暂停，等待批准。

使用提示

1. 打开 GitHub Copilot Chat。
2. 编写你的请求，列出你想要的更改。可以包含任何你喜欢的 #file: 引用。
3. 在新的一行添加触发指令 /implementation_plan。
4. 发送消息。

示例请求

I want to extract discount logic from OrderService into a separate domain service.
Keep behavior stable for all callers.
Focus on smaller methods and clearer error handling.
/implementation_plan

代理交互流程

1. Copilot 读取 你的描述以及 implementation_plan.prompt.md。
2. 代理回复一个 计划，通常包括：
   • 对现有逻辑进行扫描的有序步骤。
   • 提取辅助方法的计划。
   • 新的私有方法或新类的列表。
   • 关于行为更改和现有集成的风险说明。
   • 新结构的示例代码。
3. 你 审查 该计划并给出评论，例如：
   • “保持公共接口不变。”
   • “避免更改日志行为。”
   • “稍后添加一步更新相关单元测试。”
4. 代理 更新 计划并发送新版本。
5. 一旦你批准，代理便继续进行编辑。

好处

• 明确范围：每个 Pull Request 都遵循已商定的计划，使范围清晰可见。
• 风险缓解：潜在的危险更改（例如文件删除）会被标记并需要明确确认。
• 一致性：团队中所有开发者使用相同的提示文件，确保与 Copilot Agent 的协作保持统一。
• 增量重构：复杂的重构被拆分为更小、具名的步骤，减少意外失败。

扩展思路

为其他类型的工作创建额外的提示文件，全部放在 .github/prompts 下：

• security_review.prompt.md
• performance_review.prompt.md
• migration_plan.prompt.md

它们都遵循相同的模式：前置元数据选择器以及在任何代码更改之前请求详细、可审查的计划。

结论

在仓库中添加 implementation_plan.prompt.md 能鼓励开发者花更多时间评估实现计划，少花时间修复意外问题。这个简单、可复用的提示提升了与 GitHub Copilot Agent 的协作，使大规模代码更改更安全、更可预测。