깃 PR 템플릿 생성하기

tomchaccom·2025년 11월 15일

git

목록 보기
3/5

저번에는 이슈 템플릿을 만들어봤다. pull_request 템플릿은 다른 방식으로 만들어야 해서 이를 한번 다뤄 보겠다

Pull Request 란?

  • 본인 브랜치에서 개발한 내용을 default 브랜치에 merge 하기 전 단계이다
  • PR에서 코드 리뷰 및 merge 승인 등의 과정을 거친 뒤 merge를 진행한다

PR 템플릿 구성

간단하게 아래 형식으로 템플릿을 만들어 보겠다

### 🔨작업 내용
### 📸이미지 첨부(API 요청/응답 형식 및 실제 동작 또는 UI변경)
### ❗️관련된 이슈
### 🤔고려사항

이제 템플릿을 만들어 봅시다

  1. 내 프로젝트 바로 아래에 /.github 디렉토리를 생성한다. 이미 이슈 템플릿을 깃에서 만든 경우는 .github 폴더가 이미 존재하므로 바로 PR 템플릿을 생성하면 된다
  • 깃허브는 /.github/ 폴더를 인식해서 자동으로 PR 템플릿을 적용하기 때문에 .github를 먼저 생성
  1. 폴더 아래에 pull_request_template.md 생성하기
  1. 템플릿에 내용을 작성하기

  2. push 후 PR 생성하기

  3. PR 생성 완료~

PR 템플릿 생성 시 주의점

위 템플릿을 만드는 과정에서 .github 디렉토리를 만들때 아래처럼 프로젝트 폴더 바로 하위에 .github가 존재해야한다

두번째 주의점은 앞서 이슈 템플릿을 생성한 경우에는 .github 내부에 ISSUE_TEMPLATE 라는 디렉토리 내에 git에서 생성했던 이슈 템플릿이 존재할 것이다

이미 .github디렉토리가 생성되어 있기 때문에 사진처럼 PR 템플릿을 .github 디렉토리에 두고 ISSUE_TEMPLATE와 같이 두어야 PR 템플릿이 제대로 동작한다

글을 마치며

저는 아무것도 몰라서 ISSUE_TEMPLATE 처럼 디렉토리도 만들고 지워보고 계속 push 하면서 템플릿이 적용된것을 확인했는데 이 글을 보고 한번에 생성하시길 바라겠습니다.

profile
백엔드 개발과 친해지기!

0개의 댓글