[Github] Github 이슈, PR 템플릿 만들기

 

Github 이슈, PR 템플릿 이 뭔데?

개발 하다보면, 여러명의 같은 파트원들과 작업을 동시에 해야하기 때문에
서로 Pull 을 요청하는 Pull Request 를 올리기도 하고, 내가 하는 작업에 대한표시를 위해 issue 를 올리는데요.

1. 이슈 템플릿 (Issue Templates)

이슈 템플릿은 버그, 기능 요청, 작업 항목 등에 대한 설명을 표준화된 형식으로 작성할 수 있도록 돕습니다.

2. PR 템플릿 (Pull Request Templates)

PR 템플릿은 코드 변경 사항을 설명하고, 리뷰어가 이해하기 쉽게 작성하는 데 도움을 줍니다.

협업을 함에 있어서 해당 작업은 없어서는 안되는 필수적인 요소라고 생각합니다
그래서 원활한 협업을 위해서 이번에는 깃헙 이슈와 PR 템플릿을 만들어 보려고 합니다!
그렇게 어려운 작업은 아니지만, 개발자라면 어떻게 하는지 알고 있어야 하는 것이기 때문에 기록해보려 합니다 :)

 

Github 이슈 템플릿 (Issue Templates) 설정 방법

 1.  레포지토리 Settings 에 들어간다 

 

 

 2.  General > Features 에서, Issues 란의 해당 버튼을 클릭한다.

 

 

 3.  해당 화면에서, Add template 을 누른다.

3개의 선택지가 나오는데, 저는 커스텀 템플릿을 만들 것이기 때문에 Custom template 을 눌러줬습니다

 

 4.  다음과 같은 화면이 보이면, Preview and edit 버튼을 눌러 원하는 이슈 템플릿을 만든다. 

이 페이지를 모두 작성하고, 나서는 이제 커밋을 올릴 수 있는데

 

 5.  커밋 메세지를 적어 커밋한다.

저는 프로젝트에 합치는 작업을 해야하기 때문에 develop 에 바로 올리지 않고,

new branch 를 만들어서 커밋하도록 설정하였습니다!

-> 다음과 같이 설정하면, 해당 레파지토리에 PR 로 자동으로 올라갑니다!

 

 

Github PR 템플릿 (Pull Request Templates) 설정 방법

다음과 같이 .github 폴더 안에 pull_request_template.md 를 만들어서 안에

다음과 같이 내가 만들고자 하는 PR 템플릿을 넣으면 된다!