Git PR 템플릿 만드는 방법

Git PR 템플릿을 만들어야 하는 이유

  • 개발자들 간의 일관된 커뮤니케이션을 강화하고, 코드 리뷰의 효율성을 높이기 위함
  • PR의 목적과 변경 사항이 명확히 전달되어 팀 내의 협업 퀄리티와 코드의 퀄리티 향상

Git PR 템플릿 만드는 방법

Add File

GitHub 홈페이지에 들어가준 다음, 본인의 Repo에 들어가셔서 [Create new file] 버튼을 눌러줍니다.

 

템플릿 만드는 과정


Name

Name your file에는 "pull_request_template.md"을 작성해 줍니다.

 

이때 주의하셔야 할 점은 pull_request_template.md가 저장되어야 하는 위치는 Base repository에 있어야 적용되며 대소문자를 가리지 않습니다.


템플릿 내용

## Summary (Task 요약)
- 

## 변경사항을 전부다 기재합니다(코드 수정, 폴더 수정, 프리팹 이름 변경 등)
-

## 리뷰어가 핵심적으로 봐줬으면 하는 부분을 기재합니다
-


## PR Type

- [ ] Bugfix
- [ ] Feature
- [ ] Refactoring (no functional changes, no api changes)

다음으로 Edit 영역에 위 템플릿을 작성해 줍니다.

 

템플릿 양식의 경우 팀의 스타일에 맞게 작성해 줍니다.


마지막으로 Commit changes버튼을 누릅니다


최종 모습(결과)

 

Test 결과

PR을 보낼 때 자동으로 위와 같은 형식이 갖추어지는 것을 확인할 수 있습니다!