깃허브 Pull Request Template 만들기

깃허브에서 팀원들과 함께 협업을 하다 보면 풀 리퀘스트(Pull Request)를 만들게 됩니다. 상위 브랜치에 코드를 적용시키기 전에 서로 수정한 코드를 확인하며 문제가 없는지, 더 좋은 방법으로 코드를 짤 수 있는지 확인하는 과정이죠. 정해진 양식이 있지는 않지만, 통상적으로 pull request에는 어떤 작업을 했는지, 어떤 부분을 봐줬으면 좋겠는지, 등에 대한 설명을 적습니다. 그래야 팀원들이 내용을 빠르게 파악하고 코드 리뷰를 할 수 있기 때문이죠. 그러다 보니 pull request를 작성할 때도 정용화 된 양식이 있으면 좋겠죠. 깃허브에서는 이런 경우를 위해 pull request template을 만들 수 있도록 기능을 제공하고 있습니다.

---

초보자를 위한 깃허브 사용법 및 커밋 관리 방법

GitHub · Build and ship software on a single, collaborative platform

---

pull_request_template.md 만들기

템플릿을 만드는 방법은 어렵지 않습니다. .gitignore 등과 동일하게 프로젝트 디렉터리에 pull_request_template.md 파일을 하나 만든 후 메인 브랜치에 적용시켜 주면 됩니다. 그러면 깃허브가 자동으로 이 파일을 인식해서 pull request를 만들 때 템플릿을 적용시켜 줍니다. 저는 아래와 같이 템플릿을 만들어서 사용하고 있습니다.

## 📝 작업 내용

## 📷 스크린샷
<img src="" width="20%" />

## 💬 리뷰 요구사항

## 📢 메모

## ✅ PR Checklist
PR이 다음 요구 사항을 충족하는지 확인하세요.
- [ ] 커밋 메시지 컨벤션에 맞게 작성했습니다.
- [ ] 변경 사항에 대한 테스트를 했습니다. (버그 수정/기능에 대한 테스트)

pull_request_template.md가 잘 적용된 것을 볼 수 있습니다.

파일 하나를 수정한 후 pull request를 만들어보면 잘 적용이 돼있는 것을 볼 수 있습니다. 이제 pull request를 만들 때 양식에 맞춰서 작성을 하면 됩니다. 작업 내용을 설명하고, 필요하다면 스크린샷도 함께 첨부하면 좋겠죠. 특별한 요구사항이나 메모가 있다면 해당 내용도 함께 적어주면 좋습니다. 마지막으로는 커밋을 잘 했는지, 테스트를 진행했는지 체크리스트를 통해 마지막 점검을 합니다. 체크리스트의 경우에는 [x]로 표시를 하면 체크 표시가 됩니다.

Pull request template는 팀원들과 상의해서 필요한 내용들을 더 추가할 수도, 불필요한 내용들을 뺄 수도 있습니다. 정해진 틀이 없죠. 검색을 해보면 다양한 템플릿들이 존재하니 어떤 내용들이 들어가야 하는지 고민해 보고 템플릿을 만들어 보시면 되겠습니다. 

---