[GitHub] PR, Issue 템플릿 넣기

편리한 github 협업을 위해서 두고두고 쓸 pr과 issue 템플릿 넣는 방법을 빠르게 쇽삭 알아봅시다.

Issue 템플릿 넣기

이슈템플릿은 github 원격 레포에서 편리하게 만들 수 있습니다.

1. Settings 들어가기

템플릿 설정을 원하는 repository의 settings에 들어갑니다.

2. Set up templates 클릭

스크롤을 내려 Features - Issues - Set up templates 초록색 버튼을 눌러줍니다.

3. 원하는 템플릿 종류 선택

여러 종류의 템플릿을 만들어 두면 이슈를 생성 할 때 이슈의 종류에 따라 맞는 템플릿을 사용할 수 있습니다.

4. 템플릿 작성

feature request를 선택하였고 preview and edit 을 눌러줍니다.

수정을 위해 연필 버튼을 눌러줍니다!

팀에서 쓸 템플릿 내용들로 채워줍니다

• 템플릿 이름
• 템플릿에 대한 설명
• 템플릿 내용
• 기본으로 넣어 놓을 이슈 제목
• 기본으로 넣어놓을 Asignees
• 기본으로 넣어놓을 Label

 

예시 템플릿

## 💡 Feature Issue
<!-- 관련 이슈에 대해 설명해주세요. -->

## 🌿  To-do
<!-- 해야 할 일들을 적어주세요. -->
- [ ] todo

작성완료 후 오른쪽 상단의 Propose changes 를 누르고 커밋을 작성하여 commit changes 를 눌러 설정을 완료해 줍니다.

설정을 완료하여 이슈 작성 시에 다음과 같이 이슈 템플릿을 확인 할 수 있습니다.

Pull Request 템플릿 넣기

pr템플릿 추가는 issue와 다르게 원격레포에서 편하게 하는 방법을 못찾았는데 아시면 알려주세용

이슈 템플릿을 생성하면 자동으로 깃헙 레포의 최상단 경로에 .github폴더가 생깁니다.

이 폴더 안에 ISSUE_TEMPLATE이라는 폴더는 이미 생성 되어 이슈템플릿이 들어 있습니다.

아래 사진에는 이미 pr 템플릿이 만들어져 있는데 사진처럼 해당 경로에 pull_request_template.md 라는 이름의 파일을 만들어주고 템플릿 내용을 마크다운 방식으로 추가해주면 됩니다!

템플릿 마크다운 파일을 생성 하기 위해 다음을 터미널에 입력합니다.

vim pull_request_template.md

vim 편집기가 열리면 i 를 눌러 편집 모드로 전환 한 뒤 마크다운으로 구성된 원하는 템플릿 양식을 추가 해준 뒤

:wq 를 입력하여 저장하고 빠져나옵니다.

예시 템플릿

### 👀 관련 이슈
<!-- 관련 이슈를 적어주세요 -->

### ✨ 작업한 내용
<!-- 작업한 내용을 적어주세요 -->

### 🌀 PR Point
<!-- 코드리뷰가 필요한 부분이 있다면 적어주세요 -->

### 🍰 참고사항
<!-- 참고할 사항이 있다면 적어주세요 -->

### 📷 스크린샷 또는 GIF
|기능|스크린샷|
|:--:|:--:|
|||

위의 변경사항을 commit 하고 원격 저장소에 push를 완료 해주면 pr을 날릴 때 다음과 같이 pr 템플릿이 적용 된 것을 볼 수 있습니다!

+다른 레포에서 쓰던 템플릿을 쓰고 싶다면 .github폴더만 레포지터리 최상단경로에 복붙해주면 그대로 적용할 수 있습니다~~