프로젝트에 Github PR, Issue Template 적용하기

Github을 활용하여 협업을 하는 프로젝트라면 PR을 통해 서로의 코드를 리뷰하거나 Issue를 등록해 개발에 대한 이슈를 확인하곤 합니다.

물론 정해진 형식대로 작성하지 않아도 상관은 없지만, 가독성과 통일성을 위해서는 하나의 템플릿을 정하여 사용한다면 훨씬 깔끔하고 편안한 협업이 될 것입니다.

 

프로젝트에서 이 두가지의 템플릿을 세팅하여 자동으로 완성되는 작업을 해보려 합니다.

 

PR Template

PR을 통해 서로의 코드를 리뷰하는 방식을 많이 진행하게 됩니다.

 

먼저 프로젝트 루트 디렉토리에 .github 디렉토리를 생성하고, PULL_REQUEST_TEMPLATE.md 파일을 만듭니다.

 

 

위처럼 PR 할 때 원하는 내용들을 넣고 저장해줍니다.

그리고 새로운 브랜치를 만들어 PR을 요청해봅니다.

 

마크다운에 작성한 양식에 맞게 똑같이 적용되었습니다.

 

Issue Template

개발시 이슈를 등록할 때 사용합니다.

 

PR과 동일하게 .github 폴더에 ISSUE_TEMPLATE.md 파일을 생성합니다.

 

내용을 입력하고 push 합니다.

 

Repository의 Issues탭에 들어가서 New issue 버튼을 클릭합니다.

 

템플릿이 출력됩니다.