GitHub PR 템플릿이란?
GitHub Pull Request 템플릿은 저장소 루트의 .github/pull_request_template.md 파일로, 새 PR을 열 때 자동으로 본문에 채워지는 마크다운 뼈대입니다. 변경 내용 요약, 변경 유형, 테스트 방법, 체크리스트 등을 표준화하면 리뷰어가 빠르게 맥락을 파악하고 누락된 정보(테스트, 문서, 영향 범위)를 미리 점검할 수 있어 PR 리뷰 시간이 30~50% 이상 줄어듭니다.
본 도구는 가장 자주 쓰이는 섹션을 옵션화하여, 체크박스 몇 번으로 깔끔한 템플릿을 만들어 줍니다. 생성된 마크다운을 .github/pull_request_template.md 또는 .github/PULL_REQUEST_TEMPLATE/ 디렉터리에 저장하면 즉시 적용됩니다.
주요 섹션 설명
- Type of change: Conventional Commits와 짝을 이루는 변경 유형 체크. 자동 릴리즈 노트와 연계하기 좋습니다.
- Related issue:
Closes #123,Fixes #45같은 키워드는 PR 머지 시 이슈를 자동으로 닫습니다. - Screenshots: UI 변경은 Before/After 스크린샷을 강제하면 디자인 리뷰 효율이 크게 향상됩니다.
- Test plan: 어떤 케이스를 어떻게 검증했는지 명시. CI 통과 여부와 별개로 시나리오 기반 검증 흔적을 남깁니다.
- Checklist: CONTRIBUTING.md 숙지, 테스트 추가, 문서 갱신, Breaking Change 표기 등을 셀프 체크.
자주 묻는 질문 (FAQ)
Q. 여러 종류의 PR 템플릿을 쓰고 싶어요.
A. .github/PULL_REQUEST_TEMPLATE/ 디렉터리에 feature.md, hotfix.md 같은 파일을 만들고, PR 생성 URL에 ?template=feature.md를 붙이면 됩니다.
Q. "Closes #이슈" 키워드는 어떤 단어가 작동하나요?
A. close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved 가 인식됩니다. 기본 브랜치로 머지될 때 해당 이슈가 자동 닫힙니다.
Q. 템플릿이 적용되지 않아요.
A. 파일이 기본 브랜치(main 등)에 머지된 후부터 새 PR에 적용됩니다. 파일명·경로(특히 .github 폴더의 점) 확인이 필요합니다.