구현 계획을 위한 재사용 가능한 GitHub Copilot 프롬프트

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.

프론트‑머터리(front‑matter)는 이 프롬프트를 실행할 에이전트를 지정합니다. 지시는 에이전트가 순서가 매겨진 단계, 대상 파일, 변경 이유, 위험 요소, 핵심 부분에 대한 작은 코드 예시 등 구체적인 요소를 제공하도록 요구합니다. 또한 에이전트가 편집을 시작하기 전에 승인을 기다리도록 합니다.

프롬프트 사용 방법

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. 에이전트는 일반적으로 다음을 포함한 계획을 답변합니다:
   • 기존 로직을 스캔하기 위한 순서가 매겨진 단계.
   • 헬퍼 메서드 추출 계획.
   • 새로 추가될 private 메서드 또는 클래스 목록.
   • 동작 변화 및 기존 통합에 대한 위험 메모.
   • 새로운 구조에 대한 샘플 코드.
3. 사용자는 계획을 검토하고 다음과 같은 코멘트를 달아 응답합니다:
   • “공개 인터페이스는 변경하지 마세요.”
   • “로그 동작은 그대로 유지하세요.”
   • “나중에 관련 단위 테스트를 업데이트하는 단계를 추가하세요.”
4. 에이전트는 계획을 업데이트하고 새로운 버전을 보냅니다.
5. 사용자가 승인하면 에이전트는 편집을 진행합니다.

장점

• 명확한 범위: 각 풀 리퀘스트는 합의된 계획을 따르므로 범위가 명확해집니다.
• 위험 완화: 파일 삭제와 같은 잠재적으로 위험한 변경이 강조되고 명시적인 확인이 필요합니다.
• 일관성: 팀의 모든 개발자가 동일한 프롬프트 파일을 사용하므로 Copilot Agent와의 협업이 균일해집니다.
• 점진적 리팩터링: 복잡한 리팩터링을 작고 명명된 단계로 나누어 예기치 않은 실패를 줄입니다.

아이디어 확장

다른 유형의 작업을 위한 추가 프롬프트 파일을 .github/prompts 아래에 만들 수 있습니다:

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

모두 동일한 패턴을 따릅니다: 프론트‑머터리 선택자와 코드 변경 전 상세하고 검토 가능한 계획을 요구하는 내용.

결론

저장소에 implementation_plan.prompt.md를 추가하면 개발자들이 구현 계획을 판단하는 데 더 많은 시간을 할애하고, 예상치 못한 문제를 수정하는 데 쓰는 시간을 줄일 수 있습니다. 이 간단하고 재사용 가능한 프롬프트는 GitHub Copilot Agent와의 협업을 개선하고 대규모 코드 변경을 보다 안전하고 예측 가능하게 만듭니다.