GitHub - Issue & PR Template

안녕하세요. 그린입니다 🍏

이번 포스팅에서는 깃헙의 이슈 및 PR 템플릿을 사용하는 방법을 알아볼께요 🙋🏻

 

매번 우리는 깃헙을 이용하여 이슈 및 PR을 생성할때 통일된 양식을 팀원들끼리 정했다 하더라도 종종 까먹는 경우나 빼먹는 항목들이 존재할 수 있습니다.

그렇기에, 우리 팀원들과 논의된 이슈 및 PR 템플릿 자체를 생성 시 고정으로 따르도록 설정한다면, 훨씬 시간적 비용을 절약할 수 있을거에요!

 

한번 이 간단한 설정을 어떻게 하는지 쉽게 적용해볼까요?

 

---

Issue Template 적용하기

가장 우선 예제 프로젝트를 하나 만들었습니다.

레포를 새로 파고 파일 하나를 넣어뒀어요.

 

그럼 아래와 같이 레포에서는 이렇게 파일 하나만 들어간걸로 보이겠죠?

 

 

그리고 해당 레포를 클론한 로컬에서는 숨김 파일까지 본다면 이렇게 깃 로그 및 커밋 이력까지 같이 볼 수 있는 .git 파일까지 나타나죠!

 

 

자 이게 기본적으로 알고 있는 형식이라고 생각할께요.

 

이제 그럼 이슈 템플릿부터 한번 추가해봅시다!

 

첫번째 방법은 깃헙 원격 레포에서 직접 설정하는 방법입니다.

아래와 같이 깃헙 원격 레포 > Setting > Features > Issues를 봐줍니다.

 

 

여기서 Set up templates 버튼을 클릭해요!

 

 

당연히 아무것도 아직 없기에 빈 화면이 나타날거고 이렇게 Add template 할 수 있어요.

 

 

여기서 각자 목적에 맞는 템플릿을 설정할 수 있습니다.

버그 이슈인지 기능 이슈인지 샘플 템플릿이 존재하고 만약 직접 모두 커스텀한다면 커스텀 템플릿도 생성 할 수 있죠.

 

저는 커스텀 템플릿을 만들어볼께요.

 

 

이렇게 생성이 되고 우측 Preview and edit 버튼을 눌러보시면 현재 샘플로 어떻게 되어 있는지 볼 수 있고 또 수정할 수 있어요.

 

 

우리는 커스텀하게 직접 설정하길 원했으니 수정해볼까요?

 

 

이렇게 직접 모두 커스텀 설정해볼 수 있습니다.

템플릿 이름부터 설명, 그리고 이슈 본문에 들어갈 형식, 어싸인, 레이블까지 모두 설정해볼 수 있죠!

 

수정이 완료되고 변경 사항 저장을 위해 우측 상단 Propose changes를 눌러 변경 사항 커밋을 저장해야 하죠.

 

 

그럼 이제 레포에 이렇게 .github 하위 폴더에 이슈 템플릿이 들어간걸 볼 수 있어요.

 

 

그럼 한번 이슈를 등록해볼까요?

 

 

이슈 생성을 누르면 이렇게 템플릿을 선택할 수 있습니다.

 

 

그럼 이렇게 우리가 커스텀하게 생성한 이슈 형식이 나타나죠!

 

아주 쉽죠?

 

근데 여기서 알 수 있던건, 결국 .github 폴더가 생성되니 이걸 꼭 깃헙 원격 레포에서 하지 않더라도 로컬에서 직접 해당 폴더 및 파일을 생성해도 되는거죠.

 

그게 바로 두번째 방법입니다.

 

아래와 같이 로컬에서 직접 해당 .github 폴더를 생성해 하위에 ISSUE_TEMPLATE 폴더를 만들고 그 하위에 우리 이슈 템플릿 파일을 만들어줍니다.

 

여기서 한가지 다른건, 이슈 템플릿 파일을 만들때 우리가 이슈 템플릿의 이름부터 설명 그리고 레이블 등을 GUI로 딸깍해줬던걸 이제 마크다운으로 작성해서 설정을 넣어줘야해요.

 

---
name: 우리만의 이슈 템플릿
about: 작고 소중한 이슈 템플릿
title: ''
labels: bug
assignees: GREENOVER

---

## 🚀 Description

## ✅ TODO
- [ ]

 

이런식으로 말이죠!

 

이것만 유의하시고 변경 커밋을 저장하여 반영시키면 동일한 이슈 템플릿 설정 결과를 볼 수 있습니다 😄

 

자 그럼 이제 PR 템플릿도 설정해볼까요?

 

---

PR Template 적용하기

PR Template 설정은 원격 레포에서 이슈 템플릿처럼 버튼 딸깍으로 하는것이 아닌 아까 우리가 만들었던 .github 폴더에 PR 템플릿 파일을 추가하는것으로 간편히 설정이 가능합니다.

 

파일명은 PULL_REQUEST_TEMPLATE로 해주셔야 해요!

그리고 마크다운 형식이여야겠죠?

 

 

내용은 여러분들이 원하는 방법으로 해주면 됩니다.

 

## 📌 Related Issue

## 🚀 Description

## 📸 Screenshot

## 📢 Notes

 

저는 이렇게 간단히 작성해봤어요.

 

이제 해당 변경 사항을 커밋하고 푸쉬하면 반영이 되겠죠?

 

그럼 한번 PR 템플릿이 정상으로 설정 되어 있는지 확인해볼까요?

 

PR을 만들어보겠습니다 🐱

 

 

정상적으로 설정한 PR 템플릿 형식으로 PR이 기본적으로 설정되는걸 볼 수 있습니다 ㅎㅎ

 

이제 여기다가 Auto Assign까지 적용해놓으면 너무 편리하지 않을까요?

 

GitHub - Auto Assign 사용하기

 

---

마무리

자동화가 항상 모든 경우에 좋은건 아니지만, 대체적으로 편리함을 가져다 줍니다!

여러분들도 이런 작은것부터 자동화를 해보는건 어떨까요? 🤔

 

---

레퍼런스

Configuring issue templates for your repository - GitHub Docs