깃허브 이슈 템플릿과 PR 템플릿을 생성해보자

이전에 깃허브 이슈 관련 글을 올린 적이 있다.

해당 글은 아래 링크로 접속하면 볼 수 있다.

https://gugu76.tistory.com/110

 

그때 꼭 깃허브 이슈 템플릿과 PR 템플릿을 직접 생성해 보겠다고 했었는데, 이번 기회에 생성도 해보고 글도 남겨보려고 한다.

 

템플릿을 만들어두면, 일관적으로 이슈 및 PR을 생성할 수 있고, 매번 새롭게 작성하지 않아도 된다.

만약 템플릿을 만들어두지 않는다면, 다음과 같은 과정을 매번 겪어야 한다.

 

그래서 프로젝트를 진행한다면, 편리함과 일관성을 유지할 수 있도록 템플릿을 만들어보려고 한다.

 

이슈 템플릿을 생성해보자

먼저, 이슈 템플릿부터 만들어보자.

이슈를 생성하고 싶은 레포지토리에 들어가서 Settings 부분을 보면 아래와 같이 이슈 템플릿을 만들 수 있다.

Set up templates 버튼 클릭 후 Custom template을 만들어주면 된다.

 

나는 이슈 템플릿을 생성하면서 label도 아래와 같이 생성해서 사용할 수 있도록 했다.

각 이슈에 맞는 label을 설정해서 사용하면 된다.

label의 경우는 다른 글들을 참고해 보니, 참여자의 닉네임을 설정해서 이슈에 다는 경우도 있는 것 같았다.

프로젝트 특성에 따라 고민해 보고 지정해서 사용하도록 하자.

 

아래와 같이 다섯 가지 이슈 템플릿을 생성하였다.

생성 후 커밋해 주게 되면 이제 이슈 생성 시 템플릿들을 사용할 수 있게 된다.

 

이슈 생성 버튼을 클릭하면 아래와 같이 템플릿을 지정할 수 있고, 특정 템플릿에 들어가면 템플릿 생성 시 정한 내용들이 채워져 있다.

 

내용을 채운 후 이슈를 생성하면 다음과 같이 이슈가 잘 생성되는 것을 볼 수 있다.

 

PR 템플릿을 생성해 보자

PR 템플릿도 생성하는 과정은 어렵지 않다.

템플릿을 생성하고자 하는 레포지토리에 들어가서 pull_request_template.md 파일을 생성하고 내용만 지정해 주면 된다.

 

이제 PR 템플릿이 잘 작동하는지 확인해 보자.

설정한 PR 템플릿이 잘 나와서 내용을 채우고 PR을 생성하였다.

 

그런데 나는 하나 이상 리뷰어의 approve를 받은 경우 메인 브랜치에 머지를 시키는 룰을 추가하고 싶다.

그런 경우 아래와 같이 룰을 추가해 주면 된다.

 

이렇게 설정 후 아까 생성한 PR에 들어가 보면 아래와 같이 뜨는 것을 볼 수 있다,

리뷰어의 approve가 아직 하나도 없기 때문에 main 브랜치에 머지할 수 없는 것이다.

 

이렇게 이슈 템플릿과 PR 템플릿을 생성하고, 브랜치 규칙까지 지정해 봤는데, 별로 어렵지도 않았고, 이 과정을 통해서 협업이 너무나도 원활하게 진행될 수 있다는 사실에 감탄했다.

앞으로 프로젝트를 진행할 때는 꼭 처음에 이슈 템플릿과 PR 템플릿을 생성해 두고 편리하게 사용해야겠다.