https://amaran-th.github.io/Github/[Github] Issue & PR Template 설정하기/

이슈 탬플릿

이슈 탬플릿의 경우 Github에서 생성을 지원하기 떄문에 Github에서

레파지토리의 [Setting] 탭으로 들어간 뒤

Features 항목의 Issues에 있는 ‘Set up templates’ 버튼을 누르면 이슈 템플릿을 등록할 수 있는 화면이 나온다. (위 블로그 참고)

기능 요청 이슈 탬플릿

## Description

> 추가할 기능을 설명해주세요.

## To-do

- [ ] todo
- [ ] todo

## ETC (선택)

> 참고할 사항을 작성하세요.

버그 리포트 이슈 탬플릿

## 어떤 버그인가요?

> 어떤 버그인지 간결하게 설명해주세요

## 어떤 상황에서 발생한 버그인가요?

> (가능하면) Given-When-Then 형식으로 서술해주세요

## 예상 결과

> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요

## 참고할만한 자료(선택)

설정을 완료했을 때 모습

PR 탬플릿

PR 템플릿은 Issue 템플릿처럼 여러 개를 설정할 수 없다.

기본 브랜치로 설정된 브랜치(default는 main)에서 프로젝트의 최상위 경로를 기준으로 .github 폴더를 만들고 그 안에 템플릿 내용을 담은 PULL_REQUEST_TEMPLATE.md 파일을 만들면 된다.

- 제목 : feat(issue 번호): 기능명
  ex) feat(17): pull request template 작성
  (확인 후 지워주세요)

## ﹟ 연관된 이슈

> ex) #이슈번호, #이슈번호

### 📷 스크린샷/GIF 

> 이번 PR에서 작업한 스크린샷, 혹은 GIF를 첨부해주세요

## 📝 작업 내용

> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

## 💬 리뷰 요구사항(선택)

> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
>
> ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?

설정했을 때의 모습