[Github] Git Issue 템플릿 & PR 템플릿 설정하기

 

✏️ 매번 까먹어서 기록해두는 깃 이슈, 풀리퀘스트 템플릿 설정

 

 

1. 이슈(Issue) 템플릿 생성

 

⭐ 이슈 템플릿 생성 방법 <1>

 

레포지토리 > Settings > General > Issues 하위의 Set up templates 클릭한다. 

 

 

 

 

 

 

Preview and edit 버튼 클릭해서 미리보기 및 필요에 따라 수정 후 Propose changes 버튼 클릭

 

 

 

 

 

🕷️ 버그 리포트 이슈 

## 어떤 버그인가요?

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

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

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

## 예상 결과

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

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

 

 

 

➕ 기능 추가 리포트 이슈 

## 어떤 기능인가요?

> 추가하려는 기능에 대해 간결하게 설명해주세요

## 작업 상세 내용

- [ ] TODO
- [ ] TODO
- [ ] TODO

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

 

 

 

 

⭐ 이슈 템플릿 생성 방법 <2>

 

레포지토리 최상위 위치를 기준으로 ./.github/ISSUE_TEMPLATE/ 하위에 yml 파일 또는 md 파일을 추가하여 만들 수 있다.

 

 

 

 

⭐이슈 템플릿 적용 결과 

 

 

 

 

 

 

2. 풀리퀘스트(PR) 템플릿 생성

 

 

.github/ISSUE_TEMPLATE/config.yml 추가해서 템플릿 구분 가능

 

 

 

 

➕ 풀리퀘스트 템플릿 예시

## #️⃣연관된 이슈

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

## 📝작업 내용

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

### 스크린샷 (선택)

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

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