GitHub Pull Request 템플릿 적용하기

Create a Pull Request Template in GitHub

코드 리뷰를 위해 우리는 Pull Request 생성합니다. 이때 GitHub의 Pull Request Template 기능을 활용하면 보다 간편하게 일관된 형태의 PR을 작성하는 데에 도움을 받을 수 있습니다.

이번 포스팅에서는 GitHub PR 템플릿을 추가하고 활용하는 방법에 대해 살펴봅니다.

Create Template

GitHub에 로그인하고 템플릿을 추가하려는 리포지토리로 이동합니다. 그리고 1️⃣ Add file 버튼 클릭 후 드롭다운 메뉴에서 2️⃣ Create new file 버튼을 클릭합니다.

3️⃣ 새로운 파일의 이름과 위치를 지정합니다.

- `pull_request_template.md` ← 리포지토리 루트 경로에 템플릿을 추가하는 경우 
- `docs/pull_request_template.md` ← `docs` 디렉토리 하위에 템플릿을 추가하는 경우
- `.github/pull_request_template.md` ← `.github` 숨겨진 폴더 하위에 템플릿을 추가하는 경우 ⭐
- `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md` ← 템플릿을 여러개 추가하는 경우

그리고 마크다운 에디터에 4️⃣ 템플릿을 작성합니다. 아래는 우아한 형제들 기술 블로그에 공개된 템플릿을 참고하여 작성하였습니다.

### Task Overview 🎯


### Issue Ticket 🎫
- Issue Number: #

### Task Classification 🗂️
- [ ] 버그 수정 🐛
- [ ] 기능 추가 ✨
- [ ] 기능 변경 🪄
- [ ] 검증 추가 🧪
- [ ] 문서 작성 📚
- [ ] 코드 개선 ♻️
- [ ] 환경 설정 🔧

### Task Details 📑
- 💬

### Considerations 💭
- 🙊

Commit changes... 버튼을 클릭하여 리포지토리에 파일을 추가합니다.

다시 리포지토리 홈으로 이동하면 .github 디렉토리가 추가된 것을 확인할 수 있습니다. 생성한 템플릿을 열어 내용을 수정하거나 새로운 템플릿을 추가할 수 있습니다.

Start Pull Request

이렇게 추가한 템플릿은 Pull Request 작성시 불러올 수 있습니다. GitHub에서 Create pulll request를 시작하면 자동으로 템플릿을 가져와서 에디터에 반영합니다.

GitKraken의 Start Pull Request 실행하면 리포지토리에 추가한 템플릿을 선택할 수 있습니다. Git GUI 툴 대부분 유사하게 구현되어 있습니다.

---

• 🔗 GitHub Docs
• 🔗 우아한 형제들 기술 블로그