[Git] 깃허브 PR 템플릿 / Issues 템플릿 생성 (Pull Requests & Issues Template)

깃허브 PR 템플릿 / Issues 템플릿 생성

1.  개요  

프로젝트를 진행하다보면 Issues와 Pull Requests를 작성해야 되는 경우가 많다.

그럴때마다 템플릿을 다시 작성하였는데, 이번에 템플릿을 만들어 자동 생성되도록 하고자 하였다.

여기서, 템플릿이란 목차와 같은 것이다. 예를 들면  < 1. 개요 2. 구현내용 3. 변경사항 4. 스크린샷 .... >

 

2.  템플릿 생성하기  

 

우선 브랜치를 생성한 후

프로젝트 폴더로 이동하여 .github 폴더를 생성한다.

명령어는 다음과 같다.

mkdir .github

그 후 해당폴더로 이동하여

vi PULL_REQUEST_TEMPLATE.md // PR 템플릿
vi ISSUE_TEMPLATE.md // Issue 템플릿

다음과 같은 .md 파일을 생성하고 코드를 작성한다.

* 마크다운 문법을 사용해야합니다!

 

내가 작성한 예시는 다음과 같다.

## 1. 개요
<!-- 해당 기능 / 변경사항을 작업한 내용을 한 줄로 요약해서 작성합니다. --
- 관련문서 [[링크]()]

## 2. 구현내용
<!-- 너무 구체적일 필요는 없고, 해당 PR의 핵심이 되는 작업 내용들에 대해서 체크리스트 형식으로 작성해주세요. -->

## 3. 스크린샷
<!-- (선택) 구현하신 내용을 요약할 수 있는 스크린샷이나 UI 화면을 첨부해주세요. -->
- <img width="300" src="이미지 주소"/>

## 4. 레퍼런스
<!-- (선택) 다른 개발자분들이 인지해놓는다면 좋은 내용들이나 특이사항이 있다면 기술해주세요. -->
- [[링크]()]

## 5. 체크리스트
 <!-- 마지막으로 PR을 만들기 전에 확인해야 할 목록입니다. [x]를 입력하면 체크박스를 채울 수 있습니다. -->
- [] 라벨을 설정했습니다.
- [] 리뷰어를 설정했습니다.

그 후 git 레포지토리에 올려야하는데 나는 소스트리를 이용하였다.

터미널에서 git 명령어를 이용하려면

git add .
git commit -m "PR 메시지"
git push origin "브랜치명"

* 혹시 .ginignore 파일에 의해 파일을 인식하지 못한다면
https://yeshyun.tistory.com/16?category=1075054

다음 포스팅을 참고해주세요!

 

3.  마무리  

 

메인 브랜치에 merge가 되었다면, PR 혹은 Issues 작성시 자동으로 템플릿이 생성되는 것을 확인할 수 있다.

 

4. 관련 레퍼런스

 https://trustyoo86.github.io/github/2019/02/15/github-template.html