깃허브 풀 리퀘스트(Pull Request) 커맨트 탬플릿 등록하기

 

Git PR Template

 깃허브에 PR 코멘트 탬플릿을 미리 등록하면, 정해진 양식에 따라 구성원들은 PR 코멘트를 간편하게 작성할 수 있어 형상관리를 하는데 이점이 있습니다. 그래서 이번 포스트에서는 PR comment 탬플릿을 미리 지정하는 방법을 소개하겠습니다.

 

 

 

 

1. 깃허브 메인 페이지 접속

 

 

 

2. 새로운 파일 생성

 

적용했을 때 동작하게 만들 브랜치에 가서 'Create new file'을 선택한다.

 

* 참고로 아래 이미지에서는 마스터로 만들었지만, 실제 작업은 develop에서 했습니다.

 이미지 캡처를 마스터에서 했는데 헷갈리게 만든 점 사과드립니다^^ *

 

 

선택하면 아래와 같은 화면으로 이동한다.

 

 

 

3. 파일 명, 경로 지정

 

파일 명 입력 란에는 아래와 같이 '/'을 입력하여 경로를 지정할 수 있다.

 

root 아래에 탬플릿 파일을 만들 경우 바로 이름을 입력하면 되지만,

root 아래 docs 경로 아래에 만들고 싶은 경우 파일 명 앞에 'docs/'만 입력하면 해결된다.

 

경로 추가 예시)

 

 

만약 숨은(hidden) 경로 생성하고 싶으면 '.github/'를 추가하면 된다. 여러 탬플릿을 등록해서 사용하고 싶은 경우, 파일 이름 바로 앞에 'PULL_REQUEST_TEMPLATE/'를 추가해주면 된다. (아래와 같이 입력한다.) 하지만, docs나 root 외에 경로에 파일을 생성하면 탬플릿으로 인식하지 못할 수도 있기 때문에 되도록이면 정해진 위치에 생성한다.

 

마지막으로 파일 확장자를 반드시 입력해야 되는데, 파일 명 뒤에 '.ma' 또는 'txt'를 포함해야 된다.

 

 

 

4. 코멘트 탬플릿 작성

 

이제 본문에 탬플릿으로 사용할 양식을 입력한다.

 

예를 들면, 작업 내용, 수정사항, 공동 작업자나 팀, 연관 문서 등을 포함할 수 있다. 자세한 PR 코멘트 작성 권고안은 다른 포스트에서 다루어보겠습니다.

 

 

5. 코멘트 탬플릿 작성

 

탬플릿 작성이 끝났다면, 가장 하단에 코멘트 란으로 간다. 코멘트에는 해당 탬플릿에 대한 설명이나 버전을 작성한다. 탬플릿에 나올 내용은 아니므로 적당히 작성하면 된다. 문서 버전 기록 같은 느낌?

 

 

코멘트까지 작성이 되었다면 하단에 초록색 버튼을 클릭하는데 이때 어떤 브랜치로 커밋할지를 확인해야 된다. 현재 지정한 브랜치로 커밋할 것인지 아니면 새로운 브랜치에 커밋할 수도 있다.

 

 

6. 브랜치에 탬플릿 커밋

 

브랜치에 커밋을 하였다면 아래와 같이 탬플릿 파일이 생성된 걸 볼 수 있다. 만약 수정하고 싶은 경우 경로에 들어가 파일을 열고 바로 수정할 수 있다.

 

 

 

7. 탬플릿 확인

 

이제 아래와 같이 PR을 생성하면 탬플릿이 자동으로 뜨는 것을 볼 수 있다!

 

 

 

 

끝~!

 

 

 

[ 참고 문서 ]

 

https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository