Pull Request 템플릿

GitHub/GitLab Pull Request 설명 템플릿. 변경 유형, 체크리스트, 스크린샷 섹션 포함.

Gist

개요

이 PR에서 변경한 내용을 간략히 설명해주세요.

관련 이슈: closes #(이슈 번호)


변경 유형

해당하는 항목에 체크해주세요:

  • 🐛 버그 수정 (기존 기능을 깨지 않는 버그 수정)
  • ✨ 새로운 기능 (기존 기능을 깨지 않는 기능 추가)
  • 💥 브레이킹 체인지 (기존 기능이 변경되거나 깨지는 수정)
  • 📝 문서 업데이트
  • 🎨 코드 스타일 (린트, 포맷팅)
  • ♻️ 리팩토링 (버그 수정도 기능 추가도 아닌 코드 변경)
  • ⚡ 성능 개선
  • ✅ 테스트 추가/수정
  • 🔧 빌드/CI 설정 변경
  • 🔒 보안 수정

변경 사항 상세

무엇을 변경했나요?

변경 사항을 구체적으로 설명하세요.

왜 이렇게 변경했나요?

기술적 결정의 이유를 설명하세요.

다른 방법도 고려했나요?

대안을 고려했다면 왜 현재 방법을 선택했는지 설명하세요.


테스트

어떻게 테스트했는지 설명해주세요:

  • 단위 테스트
  • 통합 테스트
  • 수동 테스트

테스트 환경:

  • OS: macOS 14 / Ubuntu 22.04
  • Node.js: 20.x
  • 브라우저: Chrome 124, Firefox 125

스크린샷 (UI 변경의 경우)

변경 전변경 후
[before screenshot][after screenshot]

체크리스트

  • 셀프 코드 리뷰를 했습니다
  • 코드에 주석을 추가했습니다 (특히 이해하기 어려운 부분)
  • 관련 문서를 업데이트했습니다
  • 변경 사항으로 인해 새로운 경고가 발생하지 않습니다
  • 테스트를 추가했으며 통과합니다
  • 기존 테스트가 모두 통과합니다
  • 의존 PR이 있다면 먼저 머지되었습니다

리뷰어에게

특별히 집중해서 봐주실 부분이 있다면 적어주세요.