이전에 GitLab을 사용할 때도 MR(Merge Request) template을 따로 만들어서 사용헀다. 이번에 리팩토링은 GitHub에서 하기로 해서 GitHub에서도 마찬가지로 PR(Pull Request) template을 만들기로 했다.
1. PR template을 사용하는 이유
당장 팀원 2명이 빠진다면 어떻게 하실건가요?
기업연계 프로젝트 당시에 실제로 들은 말이다.
팀원이 하던 일을 내가 이어서 해야 하는 상황에서, 빨리 기능 개발을 해야한다면?
그 만큼 평소에 코드리뷰가 중요하다는 이야기다.
GitLab으로 프로젝트를 할 당시에 MR을 올리면 반드시 MR의 내용과 코드 변경사항을 확인 후 approve를 해 주는 프로세스를 거쳤다.
코드리뷰라는 추가적인 시간이 필요하긴 하지만 다른 팀원이 작성한 코드를 보고 개선할 점을 찾아줄 수 있고, 반대로 내 코드에서 개선점을 찾을 수 있다. 또한 팀원들의 작업 현황을 파악할 수 있고, 프로젝트의 진행도를 확인할 수 있다는 장점이 있다.
이러한 장점을 가지고 있는 코드리뷰를 도와주는 게 바로 PR template이다.
리뷰어는 PR template을 통해 시간을 절약할 수 있고, PR 요청자는 PR template을 작성하면서 한번 더 코드를 체크할 수 있다.
2. GitHub PR template 추가하기
2.1. pull_request_template.md 파일 생성
pull_request_template.md는 Base repository에 있어야 적용되며 대소문자를 가리지 않는다.
아래 중 한 곳에 생성하면 된다.
.github/pull_request_template.mddocs/pull_request_template.mdroot directory 아래/pull_request_template.md
GitLab을 사용할 때도 .gitlab 아래에 만들었기 때문에 이번에도 github 아래에 만들었다.
2.2. 템플릿 작성하기
내 경우, Part와 작업 내용, 이미지 첨부, 앞으로의 과제, 이슈 링크로 나눠 작성했다.
- Part
- FE인지, BE인지 구분했다.
- 내 경우 FE와 BE의 레포가 구분되어 있어서 FE로 고정해놨다.
- 작업 내용
- 간단하게 어떤 작업을 했는지 작성한다.
- 혹은 어떤 이유로 어떤 코드를 작성했는지 구체적으로 적기도 한다.
- 이미지 첨부
- 작업 내용만 적으면 직관적이지 않기 때문에 화면이 변경되었다면 어떻게 수정되었는지 보여주기 위해 사진도 첨부한다.
- 앞으로의 과제
- 현재 PR이 끝나고 어떤 일을 할지 적었다.
- 이슈 링크
- Jira 링크를 걸어도 된다.
내가 작성한 템플릿은 아래와 같다.
- 제목 : feat(issue 번호): 기능명
ex) feat(17): pull request template 작성
(확인 후 지워주세요)
## 🔘Part
- [x] FE
<br/>
## 🔎 작업 내용
- 기능에서 어떤 부분이
- 구현되었는지 설명해주세요
<br/>
## 이미지 첨부
<img src="파일주소" width="50%" height="50%"/>
<br/>
## 🔧 앞으로의 과제
- 내일 할 일을
- 적어주세요
<br/>
## ➕ 이슈 링크
- [레포 이름 #이슈번호](이슈 주소)
<br/>
2.3. template 확인하기
위의 과정을 모두 거치면 아래와 같이 PR template이 자동 설정되는 것을 확인할 수 있다.
