본문 바로가기
🤖 생산성 Up & Tips

깃허브 저장소에서 이슈 템플릿, PR 템플릿 적용하기 (feat. .github 폴더)

by kukim 2022. 4. 4.

깃허브 저장소에서 다른 사람과 협업한다고 가정하자.  
많은 사람들이 이슈나 PR 생성한다. 이때 통일된 구조로 이슈나 PR을 보낼 수 없을까?  
저장소 최상위 폴더에 ".github 폴더"에 Templates file를 추가하여 기본 템플릿을 지정할 수 있다. (단, .github 폴더는 github 저장소의 defalut(기본)에 있어야 적용된다)  (소스코드 저장소)

 


PR Templates

PR 템플릿 없이 PR을 생성하면 템플릿 없이 비어있는 PR이 생성된다.

PT Templates 파일 추가

저장소의 최상위 디렉토리에 '.github' 폴더와 PULL_REQUEST_TEMPLATE.md 파일에 아래 내용을 생성한다.

// PULL_REQUEST_TEMPLATE.md 파일

### 📝 Description

### 💻 How To Test

### 💽 Commits

### 🖼 결과

PR 생성시 자동으로 위 markdown 내용이 본문으로 들어있는 것을 볼 수 있다.

PULL_REQUEST_TEMPLATE.md 파일이 PR 생성시 자동으로 들어 있다.


Issue Templates

Issue 생성도 템플릿 설정 없이는 비어있는 Issue가 나온다.

Issue Templates 추가

 

1개의 Issue Templates

PR Templates와 마찬가지로 .github/ISSUE_TEMPLATE.md 파일을 생성하고 템플릿 할 내용을 추가하면 된다.

 

n개의 IssueTemplates

Issue는 Templates를 1개 이상 만들 수 있다. .github/ISSUE_TEMPLATE/ 폴더 밑에 n개의 .md를 만들면 된다.

직접 md 파일을 만들어도 되지만 github에서 제공하는 GUI로 손쉽게 만들 수 있다.

ㅇsettings - Features - Issues에 check box
Issues - Setup Templates 클릭
기본 템플릿 2개 (Bug report, Feature request)와 Custom template가 제공된다.
기본 제공되는 Bug report 클릭하면 - github/ISSUE_TEMPLATE/bug_report.md 파일을 생성한다는 커밋이다.

.github/ISSUE_TEMPLATE/*.md 파일 확인

.github/ISSUE_TEMPLATE를 추가하고 New Issue 생성하면

 

설정한 개수 만큼의 이슈 템플릿이 나온다.

 

Defalut 템플릿 내용일 변경하고 싶다면 .github/ISSUE_TEMPLATE/ 의 파일을 직접 수정하면 된다.


Reference

Templates 예시 저장소 Link

Create a pull request template for your repository (Github)

Configuring issue templates for your repository(Github)

태그

댓글2