[GIT] GitHub PR 템플릿, Issue 템플릿 만들기

안녕하세요. 점냥입니다:)

 

요즘 여러 명과 프로젝트를 진행할 기회가 많이 생겼어요! 굉장히 기대가 많이 됩니다.

하지만 여러명과 협업을 진행하다 보면 맞춰야 하는 사항들이 많아요. 코드 구현하는 것도 사람마다 스타일이 다르고

 

오늘의 주제인 Github PR이나 Issue 작성 글도 서로 이야기를 해서 동일한 형식으로 맞추는 것이 좋습니다.

 

GitHub PR, Issue

PR은 Pull Request의 줄임말로 여러 브랜치로 나누어 작업하고 master 혹은 develop 브랜치로 merge 할 때

코드 리뷰를 받기 위해 사용하는 기능입니다.

 

Issue는 commit 단위로 진행되는 Git에서 기능을 명시적으로 구별할 수 있게 도움을 주는 Github의 기능입니다.

 

PR과 Issue는 나 자신이 아닌 팀원들에게 내가 한 작업을 설명하는 글이기도 하기에

템플릿을 사용하여 동일한 형태로 만드는 것이 협업의 효율성을 높일 수 있을 것입니다!

 

PR, Issue 템플릿 적용하기

 

템플릿 파일 생성

mkdir .github

적용하려는 프로젝트의 상위 폴더로 이동해주세요. 그리고 .github파일을 생성해주세요.

 

이후, .github 폴더 내에 PR 템플릿 파일을 생성하려면 아래의 명령어를 사용해주세요.

vi PULL_REQUEST_TEMPLATE.md

 

Issue 템플릿 파일은 아래의 명령어를 작성해서 생성하면 됩니다.

vi ISSUE_TEMPLATE.md

 

vi 명령어는 뒤에 나오는 파일명이 존재한다면 수정을, 존재하지 않는 다면 생성하는 명령어입니다!

 

템플릿 파일들은 md 확장자 파일이기 때문에 마크 다운 문법을 사용하여 템플릿을 정의해야 해요

 

ex) PullRequest 템플릿

## 개요
- Issue 번호를 적어주세요.
- 내용을 적어주세요.

## 작업사항
- 내용을 적어주세요.

## 변경로직(optional)
- 내용을 적어주세요.

 

템플릿 파일들의 내용은 회의를 통해 가장 알맞은 형식을 작성하면 됩니다. 

저장하려면 esc + wq 사용하시면 됩니다.

 

 

템플릿 적용

템플릿 파일을 적용하는 방법은 매우 간단합니다.

생성한 파일들을 리모트 저장소에 올리면 끝!

 

git add .
git commit -m "Pull Request 템플릿 생성"
git push origin develop

 

위 작업을 완료한 후, 저장소에서 PR을 생성하면 템플릿이 적용된 모습을 볼 수 있습니다!

 

참고

- 헤이 딜러 개발팀의 규칙