깃허브에서 이슈나 PR을 만들 때, 매번 동일한 형식을 직접 작성하는 것은 너무 번거롭다.
이때 템플릿 파일을 만들어 두면, 새로운 이슈나 PR을 생성할 때 자동으로 템플릿이 불러와진다.
이번 글에서는 이슈 템플릿과 PR 템플릿을 적용하는 방법을 예시 코드와 함께 정리한다.
이슈 템플릿 적용하기
프로젝트 루트 경로에 `./.github/ISSUE_TEMPLATE/bug-report-template.md` 파일을 생성한다.
---
name: "\U0001F41EBug"
about: 버그 리포트 템플릿
title: ''
labels: ''
assignees: ''
---
<!-- 작성하지 않은 항목은 모두 지워주세요 -->
## 🐞버그 설명
<!-- 어떤 상황에서 어떤 문제가 발생했는지 구체적으로 작성해주세요 -->
<br/>
## 🐛에러 로그
<!-- 콘솔에 찍힌 에러 로그나 네트워크 응답 에러가 있다면 코드 블럭에 포함해주세요 -->
<br/>
## ✅작업할 내용
<!-- 이 버그를 해결하기 위해 예상되는 작업을 세분화해서 체크박스 형태로 작성해주세요 -->
<br/>
## 📸스크린샷
<!-- 시각적으로 이해를 돕기 위한 스크린샷이 있다면 첨부해주세요 -->
<br/>
## 📑참고 문서
<!-- 참고할 수 있는 자료가 있다면 적어주세요 -->
`bug-report-template.md` 파일에 원하는 템플릿 내용을 마크다운 문법으로 작성한다.
이슈는 기능 추가, 버그 제보 등 다양한 템플릿을 만들 수 있지만, 여기서는 버그 리포트 템플릿만 작성해 보았다.
이 파일을 `main` 브랜치에 반영하면, 새로운 이슈를 생성할 때 템플릿 선택 화면이 나타난다.
그러면 위에서 만든 템플릿에 맞춰 이슈를 작성하면 된다.
PR 템플릿 적용하기
프로젝트 루트 경로에 `./.github\pull_request_template.md` 파일을 생성한다.
<!-- 제목 예시: [feat] 관리자 페이지 구현 -->
<!-- 작성하지 않은 항목은 모두 지워주세요 -->
## 🔎개요
<!-- 구현한 기능에 대해 간단하게 설명해주세요 -->
<br/>
## 📝작업 내용
<!-- 구현한 기능에 대한 구체적인 내용을 작성해주세요 -->
<br/>
## 👀변경 사항
<!-- 컴포넌트, API, 로직 등 코드 변경으로 인해 협업 시 다른 개발자가 주의해야 할 내용이 있다면 작성해주세요 -->
<br/>
## 📸UI 스크린샷
<!-- UI에 변경이 있을 경우, 실제 화면을 캡처해서 첨부해주세요 -->
<br/>
## 📦패키지 설치
<!-- 새로 설치한 패키지와 설치 이유를 설명해주세요 -->
<br/>
## #️⃣관련 이슈
<!-- 해당 PR과 관련된 이슈 번호가 있다면 "- #22" 형태로 작성해주세요 -->역시나 마크다운 문법으로 PR에 필요한 항목들을 작성했다.
이 파일 또한 `main` 브랜치에 반영하면, PR 작성 시 자동으로 템플릿이 불러와진다.