[GitHub] 깃허브 PR 템플릿 만들기

GitHub PR 템플릿 만들기

깃허브에서 PR을 계속해서 날리다보면 일관성 없는 형태로 PR이 작성될 때가 있다. 또한 협업시 PR 작성을 할 때 기본적인 형식을 정해놓고 해야 협업의 효율성을 높일 수 있다. 그래서 오늘은 PR 템플릿 파일을 만드는 과정에 대해 정리해보고자 한다.

 

 

참고

• 직접 클론해서 로컬에서 작업을 하고 커밋을 해도 괜찮고 깃허브 원격 저장소에서 추가해줘도 괜찮다.
• 아래 설명은 로컬에서 git bash를 활용해 작업한 기준으로 설명한다.

 

 

1. 저장소의 상위폴더에서 .github라는 폴더를 생성한다. 이미 폴더가 있다면 다음으로 넘어가면 된다.

mkdir .github

 

2. .github 폴더로 이동하고 폴더 내에 PULL_REQUEST_TEMPLATE.md (파일명을 소문자로 해도 가능)파일을 생성한다. 이 파일명이 깃허브에서 예약어처럼 지정된 템플릿 명이기 때문에 파일명을 바꾸거나 하면 PR 템플릿으로 인식되지 않는다. 멀티 템플릿을 사용하기 위해 PULL_REQUEST_TEMPLATE 폴더에 템플릿 파일들을 넣어주는 방법도 있지만 이 글에서 다루지는 않겠다.

# .github 폴더로 이동
cd .github

# PR 템플릿 파일 생성
vi PULL_REQUEST_TEMPLATE.md

 

PULL_REQUEST_TEMPLATE.md 파일 안에 아래와 같이 원하는 형식으로 템플릿 내용을 만들어주면 된다.

# 진행 사항
- 

<br>

# 테스트 항목
-

 

3. 생성한 PR 템플릿을 커밋해준다.

 

4. 이제 PR을 생성할 때마다 아래와 같이 템플릿이 적용된 상태로 작성할 수 있다.

 

 

만일, 커밋을 했음에도 불구하고 템플릿을 사용할 수 없다면 PR 템플릿이 default branch에 반영되어 있는지 확인해봐야 한다. default branch를 기준으로 템플릿이 적용되기 때문에 default branch에 템플릿 커밋을 반영하거나 default branch를 변경해줘야 한다.

 

 

 

 

 

https://soft.plusblog.co.kr/66

[GitHub] PR 템플릿, 이슈 템플릿 등록하기 (Pull Request Template, Issue Template)

https://jaeryo2357.tistory.com/87

[GIT] GitHub PR 템플릿, Issue 템플릿 만들기