PR Template : GitHub 같은 협업 플랫폼에서 Pull Request(=코드 병합 요청) 를 올릴 때, 팀원들이 항상 일정한 형식으로 내용을 작성하도록 도와주는 템플릿
PR Template 이란?
- Pull Request를 작성할 때 자동으로 불러와지는 문서 양식
- 팀이 미리 정해둔 질문/체크리스트/항목을 따라 작성하도록 강제 → PR 품질 ↑, 리뷰 시간 ↓
- GitHub, GitLab, Bitbucket 등에서 지원
왜 필요할까?
- 일관성 유지 → 모든 팀원이 같은 형식으로 PR 작성
- 리뷰 효율성 → 리뷰어가 필요한 정보(변경 내용, 테스트 방법 등)를 빠짐없이 확인
- 히스토리 관리 → 나중에 어떤 변경을 왜 했는지 문서화 효과
- 협업 표준화 → “이 PR에 뭘 적어야 하지?” 고민 불필요
GitHub에서 PR Template 만드는 법
- 저장소 루트에
.github/디렉토리 생성 - 그 안에
PULL_REQUEST_TEMPLATE.md파일 작성
(또는.github/pull_request_template.md)
1) 기능 개발용 (Feature PR Template)
## 기능 개발 PR
## 개요
- 어떤 기능을 개발했는지 간단히 요약해주세요.
### 주요 변경 사항
- [ ] 새로운 API 추가
- [ ] UI 변경
- [ ] 서비스 로직 추가/수정
- [ ] 기타: _______________
### 변경 이유
- 왜 이 기능이 필요한지, 어떤 문제를 해결하는지 설명해주세요.
### 테스트 방법
- [ ] 로컬에서 실행 및 정상 동작 확인
- [ ] 단위 테스트/통합 테스트 통과
- [ ] 기타: _______________
### 스크린샷 (선택)
- UI가 바뀌었다면 캡처 첨부해주세요.
### 주의사항
- 배포 시 영향 범위, BREAKING CHANGE 여부, 추가 설정/마이그레이션 필요 여부2) 버그 수정용 (Bugfix PR Template)
## 버그 수정 PR
### 버그 설명
- 어떤 문제가 있었는지, 어떤 상황에서 발생했는지 설명해주세요.
### 수정 내역
- [ ] 버그 원인 분석 및 해결
- [ ] 관련 테스트 케이스 추가/수정
- [ ] 로그/예외 처리 개선
### 수정 이유
- 왜 이 방식으로 해결했는지 간단히 설명해주세요.
### 테스트 방법
- [ ] 문제 재현 시나리오 실행 → 수정 후 정상 동작 확인
- [ ] 자동화 테스트 통과
- [ ] 기타: _______________
### 주의사항
- 긴급 패치 여부, 배포 시 유의사항, 관련 모듈 영향3) 긴급 핫픽스용 (Hotfix PR Template)
## 긴급 핫픽스 PR
### 이슈 개요
- 어떤 치명적 문제를 해결하는 핫픽스인지 설명해주세요.
### 수정 내용
- [ ] 서비스 장애/보안 이슈 해결
- [ ] 임시 조치 (추후 리팩토링 필요)
- [ ] 관련 설정 수정
### 테스트/검증
- [ ] 로컬/스테이징 환경 검증 완료
- [ ] 모니터링 도구로 정상 여부 확인
- [ ] 긴급 배포 후 확인할 체크리스트
### 후속 조치
- 추후 코드 정리, 리팩토링, 문서화 필요 여부
- 재발 방지 방안- Feature Template → 새로운 기능 추가 시
- Bugfix Template → 버그 수정 시
- Hotfix Template → 서비스 장애/긴급 패치 시
실제 사용 흐름
- 개발자가 새 브랜치에서 기능 작업
git push후 PR 생성- GitHub에서 자동으로 PR 템플릿 로드
- 개발자가 템플릿에 맞춰 작성
- 리뷰어는 항목을 보며 리뷰 진행
