[Git] 여러가지 템플릿 만들기 (PR, Issue, Bug)

1. PR 템플릿 만들기

이 글을 참고했다.

1. Github 버튼의 Add file > Create new file을 클릭해서
2. pull_request_template.md 라는 파일을 생성해준다.
   숨겨진 디렉토리에 저장하기 위해 .github 하위에 저장하는 방법이 일반적이다.

pull_request_template.md 내용

### 🧐 Motivation
- 코드를 추가/변경하게 된 이유를 작성해 주세요

<br>

### 🎯 Key Changes
- 주요 구현 사항을 작성해 주세요

<br>

### 💬 To Reviewers
- 리뷰어에게 전달할 말을 작성해 주세요

2. Issue 템플릿 만들기

이 글을 참고했다.

1. 레포지토리에서 Settings를 누른다.
2. 아래로 쭉 내리다가 Features > Issues > Set up templates 를 누른다.
3. Feature request > Preview and edit 을 누른다.
4. Template content 를 채운다.
5. Issue default title 에 [FEATURE] 를 입력한다.

변경 전

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

변경 후

## 📄 Description
- 이슈 내용을 적어주세요

<br>

## ✏️ Details
- 상세 내용을 적어주세요

<br>

## ✅ Check List
- [ ] todo1
- [ ] todo2
- [ ] todo3

<br>

## 📍 Reference
- 참고 자료를 적어주세요

3. Bug 템플릿 만들기

이 글을 참고했다.

1. 레포지토리에서 Settings를 누른다.
2. 아래로 쭉 내리다가 Features > Set up templates 를 누른다.
3. Bug request > Preview and edit 을 누른다.
4. Template content 를 채운다.
5. Issue default title 에 [BUG] 를 입력한다.

변경 전

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
 - OS: [e.g. iOS]
 - Browser [e.g. chrome, safari]
 - Version [e.g. 22]

**Smartphone (please complete the following information):**
 - Device: [e.g. iPhone6]
 - OS: [e.g. iOS8.1]
 - Browser [e.g. stock browser, safari]
 - Version [e.g. 22]

**Additional context**
Add any other context about the problem here.

변경 후

## 📄 Description
- 어떤 버그인지 간결하게 설명해주세요.

<br>

## 💥 To Reproduce
어떤 식으로 버그가 발생했는지 순서대로 적어주세요.
1. 무엇을 하기 위해
2. 무얼 호출했더니
3. 어떤 에러가 발생했다.

<br>

## 📸 Screenshots
- 에러 이미지를 첨부해주세요.

---

💛 개인 공부 기록용 블로그입니다. 👻

맨 위로 이동하기