GitHub

[GitHub] 이슈, PR 템플릿 적용하기

hong-seonah 2025. 1. 14. 00:32

1. 이슈 템플릿

레포지토리 내의 [Setting] - [Features]에서 Issues의 Set up templates를 누른다.

 

나는 이미 만들어둔 템플릿이 있어 위 사진과 같이 뜨는데, 처음 접근한다면 Add template만 뜰 것이다.

 

Custom templete 선택 후 위와 같이 원하는 내용을 입력하면 된다.

 

전부 입력했다면 Propose changes를 누르면 저장된다.

1-2. 이슈 라벨

레포지토리의 이슈 부분에서 빨간색으로 표시된 라벨을 선택하면 새로운 라벨을 생성하거나, 수정 및 삭제할 수 있다.

난 위와 같이 4가지 라벨만 만들었다.

 

2. PR 템플릿

원하는 레포지토리의 .github 폴더에 들어가서 PULL_REQUEST_TEMPLATE.md 파일을 생성한다.

마크다운 형식의 원하는 템플릿을 입력하면, PR 템플릿이 작성된다. 내가 사용한 템플릿은 아래와 같다.

더보기

## 📢 기능 설명

필요시 실행결과 스크린샷 첨부

<br>

 

## 연결된 issue

연결된 issue를 자동을 닫기 위해 아래 {이슈넘버}를 입력해주세요. <br>

close #{이슈넘버}

<br>

 

##  체크리스트

- [ ] PR 제목 규칙 잘 지켰는가?

- [ ] 추가/수정사항을 설명하였는가?

- [ ] 이슈넘버를 적었는가?