GitHub Issue & PR Template 설정하기

글을 시작하며

GitHub에서 프로젝트를 진행하다 보면 수많은 이슈와 풀 리퀘스트를 작성하게 됩니다. 여러 팀원들과 협업할 때, 일관된 코드 리뷰와 명확한 이슈 관리를 위한 체계적인 방법이 필요합니다. 이번 글에서는 GitHub에서 제공하는 Issue 템플릿과 PR 템플릿을 설정하는 방법과 예시에 대해 알아보려 합니다.

Issue Template이란?

이슈 템플릿은 새로운 이슈를 생성할 때 미리 정의된 양식을 제공하는 기능입니다. 버그 리포트, 기능 제안, 문서 수정 등 다양한 유형의 템플릿을 만들어 활용할 수 있습니다.

Issue Template 설정 방법

프로젝트 루트에 .github/ISSUE_TEMPLATE 디렉토리 생성
markdown 형식으로 템플릿 파일 작성
필요한 섹션과 체크리스트 정의

Issue Template 예시

---
name: '구현 할 이슈를 작성해주세요'
about: 이슈 템플릿
title: '[feat] 구현할 기능을 입력해 주세요'
labels: ''
assignees: ''
---

## 🚧 Description

<!-- 설명을 작성해 주세요. -->

## ✅ Todo

- [ ] 구현 내용 1
- [ ] 구현 내용 2

## 🛠️ETC

<!-- 참고한 블로그나 깨달은 점 등을 기록해주세요 -->

Pull Request Template이란?

PR 템플릿은 코드 변경사항을 제출할 때 사용되는 표준화된 양식입니다. 변경사항의 목적, 테스트 여부, 관련 이슈 등을 체계적으로 기록할 수 있습니다.

PR Template 설정 방법

프로젝트 루트에 .github/PULL_REQUEST_TEMPLATE.md 파일 생성
필요한 섹션과 체크리스트 정의

PR Template 예시

## 이슈

- #이슈번호

close #118

## 어떤 이유로 PR를 하셨나요?

- [ ] feature 병합
- [ ] 버그 수정
- [ ] 코드 개선
- [ ] 기타(아래에 자세한 내용을 기입해주세요)

## 작업 사항

- 작업한 내용을 적어주세요.

## 참고 사항

- 공유할 내용, 스크린샷 등을 넣어 주세요.

템플릿 사용의 장점

일관성 유지: 모든 팀원이 동일한 형식으로 정보를 작성
필수 정보 누락 방지: 중요한 정보를 빠뜨리지 않고 작성 가능
리뷰 효율성 향상: 표준화된 형식으로 인한 빠른 리뷰 가능
온보딩 시간 단축: 새로운 팀원도 쉽게 적응 가능

추가 팁

템플릿은 팀의 특성과 프로젝트 성격에 맞게 커스터마이징하세요
너무 많은 항목은 오히려 작성을 방해할 수 있으니 적절한 수준을 유지하세요
정기적으로 팀원들의 피드백을 받아 템플릿을 개선하세요
마크다운 문법을 활용해 가독성을 높이세요

결론

Issue와 PR 템플릿은 작은 설정으로 큰 효과를 볼 수 있는 협업 도구입니다. 처음에는 약간의 시간이 필요할 수 있지만, 장기적으로는 팀의 생산성과 코드 품질 향상에 크게 기여할 것입니다.
지금 당장 여러분의 프로젝트에 템플릿을 적용해보세요! 🚀