동료의 작업물을 리뷰해야할 일이 생길 때, 가장 먼저 보게 되는 것이 코드보다 Pull Request (이하 PR)의 내용이다. PR 내용은 코드를 마주하기 전 내 작업물을 동료에게 소개하는 일종의 제안서라고 볼 수 있다. 그런데 협업을 하다보면 개인의 성향마다 이 내용이 편차가 생기기 마련이다. 개개인별로 PR에 대한 작업 설명이 상이하게 되면, 리뷰어 또한 PR을 확인할 때 해당 작업 결과물에 대한 사전 이해도도 상이하게 된다. 이를 방지하고자 Github에 PR을 올릴 때 공통 Template을 적용하여 작업물에 대한 이해도를 평준화시킬 수 있다.
TL;DR
Github에 PR 템플릿을 적용하면 작업물에 대한 이해도를 평준화시킬 수 있으며, 리뷰어는 작업자가 어떤 의도로 작업을 했는지에 대해 이해도를 가진 상태에서 리뷰를 진행할 수 있기 때문에 리뷰 품질이 높아지게 된다.
이 글에서 다루는 것
- Github PR Template 세팅 방법
Github PR Template 세팅하기
1. .github 디렉토리 생성
프로젝트의 루트 디렉토리에 .github 디렉토리를 생성한다.
2. PULL_REQUEST_TEMPLATE.md 파일 작성
.github 디렉토리 내에 PULL_REQUEST_TEMPLATE.md 파일을 생성한다. 파일 이름을 정확히 PULL_REQUEST_TEMPLATE.md로 해야 GitHub이 자동으로 인식한다.
3. PR Template으로 사용할 내용을 작성한다.
PR Template은 예를 들어 아래와 같이 작성할 수 있다.
## 작업 내용
간단한 작업 내용에 대한 요약을 적어주세요.
## 변경 사항
주요 변경 사항이나 추가된 기능에 대해 설명해주세요.
## 주의사항
리뷰어에게 주의해야 할 사항이나 특이사항이 있다면 여기에 적어주세요.
## 테스트 방법
변경된 코드를 테스트하는 방법을 설명해주세요.템플릿에는 가급적 리뷰어가 이해하기 쉽도록 작업의 개괄적인 내용을 적는다.
4. Github의 deafult branch에 PR Template 내용을 적용시킨다.
대부분 main branch가 default branch이기 때문에 해당 branch에 PR Template을 적용해야 GitHub에서 PR을 올릴 때마다 위에서 작성한 Template이 자동으로 뜨게 된다.
'개발' 카테고리의 다른 글
| husky로 팀의 코드 자산에 대한 그라운드 룰 유지하기 (1) | 2023.11.30 |
|---|---|
| EC2에 docker 배포 시 디스크 용량 정리 (0) | 2022.10.25 |
| 오류가 난 도커 컨테이너의 내부 파일 수정하기 (0) | 2022.10.24 |
| dind(docker in docker) 방식으로 gitlab-runner 등록하기 (0) | 2022.10.23 |
| Airflow 로컬에서 세팅하기 (0) | 2022.10.15 |
