Pull Request 설명을 작성하는 프롬프트

언제 사용하나

리뷰어가 맥락을 빠르게 파악할 수 있는 PR 설명이 필요할 때.

요청 전 확인

• 변경 diff와 관련 이슈, 검증 방법을 준비한다.

복사해서 쓰는 프롬프트

아래 변경 내용으로 Pull Request 설명을 작성해줘.

변경 요약/diff: {{DIFF_OR_SUMMARY}}
관련 이슈: {{ISSUE}}

원하는 구성:
1. 무엇을 왜 바꿨는지(문제 → 해결)
2. 주요 변경점 요약(파일/모듈 단위)
3. 리뷰어가 집중해서 볼 부분과 열린 질문
4. 검증 방법(실행한 테스트/수동 확인)
5. 스크린샷/로그가 필요한지 여부와 위치 표시

placeholder 설명

• {{DIFF_OR_SUMMARY}} : 변경 요약 또는 diff
• {{ISSUE}} : 관련 이슈 번호/링크

입력 예시

{{ISSUE}} = "#123"

기대 결과

배경·변경점·검증·리뷰 포인트가 담긴 PR 설명.

검증 방법

설명만 읽고 동료가 변경 의도를 이해하는지 확인한다.

주의사항

• "무엇"만 적고 "왜"를 빠뜨리면 리뷰가 느려진다.

관련 문서

• GitHub PR 작성: https://docs.github.com/ko/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request