GitHub ISSUE & PR TEMPLATES

GitHub을 활용하는 프로젝트라면 Issue를 등록해 프로젝트의 이슈를 관리하거나, Pull Requests를 통해 코드를 리뷰할 수 있습니다.

작성자마다 기록하는 방식이 제각각이라면, 통일성이 떨어질 뿐 아니라 가독성에서도 좋지 않습니다.

GitHub은 효과적인 협업을 위해 Issue와 PR에서 템플릿을 제공하고있습니다.

Issue Template

GitHub Issues를 등록할 때 사용하게 됩니다.

GitHub 저장소 루트 디렉토리(Root directory)에 .github 숨김 폴더를 생성합니다.

ISSUE_TEMPLATE.md 파일을 생성합니다.

위와 같은 양식으로 원하는 템플릿을 작성하고 GitHub default branch로 푸시(Push)합니다.

(따로 설정한 적이 없다면, default branch는 master 또는 main 입니다.)

GitHub에서 이슈를 만들어봅니다.

마크다운(Markdown)으로 작성한 템플릿이 바로 출력되는 것을 확인할 수 있습니다.

하지만, 여러 버그와 기능 추가 등 여러 템플릿이 있으면 좋겠는데요

.github 폴더 내에 ISSUE_TEMPLATE 폴더를 생성합니다.

버그를 위한 BUG_REPORT.md 템플릿과 기능 추가를 위한 FEATURE_REQUEST.md 파일을 생성합니다.

단일 템플릿과 다르게 상단에 템플릿 정보를 설정할 수 있습니다.

name: 템플릿 이름
about: 템플릿 설명
title: 기본 title
labels: 기본 labels
assignees: 기본 assignee (GitHub Username을 적어줍니다, 기본 설정을 원치 않으면 '' 공백으로 설정합니다.)

기능 추가를 위한 템플릿을 작성하고 GitHub default branch로 푸시합니다.

(BUG_TEMPLATE.md 는 이전에 만든 ISSUE_TEMPLATE.md 와 동일하며, 템플릿 정보만 추가되었습니다.)

GitHub에서 이슈를 만들어봅니다.

템플릿이 없거나 하나만 있을 때와 다르게 템플릿을 선택하는 화면이 보입니다.

Bug Report 템플릿을 선택해보겠습니다.

단일 템플릿과 다르게, 템플릿 정보에 입력한대로 Assignees, Labels가 기본으로 선택되어있습니다.

이제 주어진 양식대로 이슈를 등록해봅시다.

PR Template

GitHub Pull requests를 등록할 때 사용하게 됩니다.

.github 폴더 내에 PULL_REQUEST_TEMPLATE.md 파일을 생성합니다.

default branch로 푸시하고, GitHub에서 PR을 만들어봅니다.

이제 통일된 스타일로 이슈와 PR을 깔끔하게 작성할 수 있습니다.