Skip to content

3.2. 이슈 템플릿 & PR 템플릿

kylekim2123 edited this page Nov 27, 2023 · 1 revision

이슈 템플릿 (Issue template)

<!-- 이슈가 왜 필요한지, 어떤 작업을 수행할 예정인지 간단히 작성 -->
### 📝 개요
- 개요1

---

<!-- 이슈 해결에 필요한 작업을 나열 -->
### ✅ 작업 예정 목록
- [ ] 할일1

---

<!-- 이슈와 관련된 데이터를 나열 -->
### 📀 관련 데이터 (화면, 테이블, API 등)
#### 화면


#### 테이블 명
- 테이블 명 1


#### API endpoint
- endpoint 1

PR 템플릿 (Pull Request template)

## 👨‍💻 작업 사항

### 📑 PR 개요
<!-- PR에 대한 간단한 개요를 작성 -->

---

<!-- 이슈에서 지정했던 작업 목록의 완료 상태를 표시 -->
### ✅ 작업 목록
- [ ] 작업1
- [ ] 작업2
- [ ] 작업3

---

### 🙏 리뷰어에게
<!-- PR에 작성한 변경 사항에 대해 팀원들에게 설명 -->
- 설명1
- 설명2

---

### 기타
<!-- 작성하지 않으면 삭제 -->

---

### Prefix
> PR 코멘트를 작성할 때 항상 Prefix를 붙여주세요.
- `P1`: 꼭 반영해주세요 (Request changes)
- `P2`: 적극적으로 고려해주세요 (Request changes)
- `P3`: 웬만하면 반영해 주세요 (Comment)
- `P4`: 반영해도 좋고 넘어가도 좋습니다 (Approve)
- `P5`: 그냥 사소한 의견입니다 (Approve)