prompt-builder은(는) 무엇을 하나요?
사용자가 GitHub Copilot용 고품질 프롬프트를 적절한 구조, 도구 및 모범 사례를 통해 작성하도록 안내합니다.
개요
이 스킬은 GitHub Copilot에서 최상의 결과를 얻기 위한 프롬프트 작성 방법을 알려줍니다. 효과적인 프롬프트는 Copilot이 사용자의 의도를 정확히 이해하고 적절한 코드를 생성하도록 도와줍니다.
사용 방법
- 컨텍스트 제공: Copilot에게 충분한 컨텍스트를 제공하세요. 예를 들어, 파일 상단에 주석으로 목적을 설명합니다.
- 구체적인 지시: "함수 작성"보다는 "입력값을 검증하고 오류를 반환하는 함수 작성"과 같이 구체적으로 지시합니다.
- 출력 형식 지정: 원하는 출력 형식을 명시합니다. 예: "JSON 형식으로 반환" 또는 "ES6 모듈 문법 사용".
- 예시 포함: 가능하다면 입력과 출력의 예시를 프롬프트에 포함시킵니다.
모범 사례
- 명확한 언어 사용: 모호한 표현을 피하고 정확한 용어를 사용합니다.
- 단계별 접근: 복잡한 작업은 여러 단계로 나누어 프롬프트를 작성합니다.
- 테스트 코드 포함: 함수 작성 시 테스트 코드 예시를 함께 제공하면 더 정확한 결과를 얻을 수 있습니다.
- 주석 활용: 코드 내 주석을 통해 의도를 설명합니다.
예시
# 사용자로부터 이름을 입력받아 환영 메시지를 반환하는 함수
# 입력: 문자열 (이름)
# 출력: "안녕하세요, {이름}님!" 형식의 문자열
def greet(name: str) -> str:
pass
참고
- GitHub Copilot은 컨텍스트에 민감하므로 관련 파일을 열어 두는 것이 좋습니다.
- 프롬프트가 길수록 항상 좋은 것은 아니며, 핵심 정보를 간결하게 전달하는 것이 중요합니다.