GitHub PR 템플릿 생성기

GitHub PR 템플릿 생성기 사용 가이드

풀 리퀘스트 설명이 매번 한 줄뿐이면 리뷰어가 무엇을 왜 바꿨는지 파악하는 데 시간이 듭니다. 저장소에 PR 템플릿을 두면 새 PR을 열 때 정해진 항목이 미리 채워져 설명 품질이 올라갑니다.

'항목'에 쉼표나 줄바꿈으로 적은 이름마다 '## 항목' 절과 안내 주석을 만듭니다. 스크린샷·화면이 들어간 항목에는 '전후 이미지를 붙여 넣으세요', 테스트가 들어간 항목에는 '어떻게 확인했는지 적으세요'처럼 맞춤 안내가 붙습니다.

맨 아래에는 기준 브랜치 최신 상태, 테스트 실행, 문서 수정 여부를 확인하는 체크리스트가 자동으로 들어갑니다. 항목에 '체크리스트'를 적어도 중복으로 만들지 않습니다.

사용 방법

1. 1'템플릿 이름'과 '기준 브랜치 (예: main)'를 적습니다.
2. 2'항목 (쉼표나 줄바꿈으로 구분)'에 요약, 관련 이슈, 테스트 방법, 스크린샷처럼 받을 항목을 적습니다.
3. 3'실행' 후 결과를 .github/pull_request_template.md로 저장합니다.

템플릿 이름: 기본 PR
기준 브랜치: main
항목: 요약, 관련 이슈, 테스트 방법, 스크린샷, 체크리스트

<!-- 기본 PR: 아래 항목을 채워 주세요 -->

## 요약

<!-- 요약 내용을 적으세요 -->

## 관련 이슈

<!-- 관련 이슈 내용을 적으세요 -->

## 테스트 방법

<!-- 어떻게 확인했는지 적으세요 -->

## 스크린샷

<!-- 화면이 바뀌었다면 전후 이미지를 붙여 넣으세요 -->

## 체크리스트

- [ ] `main` 브랜치 기준 최신 상태입니다
- [ ] 관련 테스트를 추가하거나 실행했습니다
- [ ] 필요한 문서를 함께 고쳤습니다

이럴 때 쓰면 좋아요

• 팀 PR 설명 형식을 통일할 때
• 리뷰어가 테스트 방법을 매번 묻는 일을 줄일 때
• 오픈소스 기여자에게 PR 작성 규칙을 안내할 때
• UI 변경 PR에 스크린샷을 빠뜨리지 않게 할 때

문제가 생겼을 때

활용 팁

• 관련 이슈 절에 'Closes #123'을 적게 안내하면 PR이 병합될 때 이슈가 자동으로 닫힙니다.
• 템플릿이 너무 길면 작성자가 지우고 쓰기 쉽습니다. 항목은 네다섯 개로 유지하세요.

자주 묻는 질문