-
Notifications
You must be signed in to change notification settings - Fork 3
PR Convention
heeee__soo edited this page Apr 9, 2024
·
8 revisions
📌 PR 업로드시 꼭 github projects의 업무와 링크 시켜주세요
제목: [#Issue number] 기능 구현
PR 템플릿
<!--
제목은 `feat[#issue 번호]: 기능 구현 내용`으로 작성해 주세요
예시) feat[#Issue number]: 기능 구현
-->
## 관련 문서
- issue: #
- close #
## 유형
- [ ] 기능 구현
- [ ] UI 구현
- [ ] 리팩토링
- [ ] 버그 해결
- [ ] 문서 업데이트
- [ ] 기타( )
## 작업 내용
<!-- 작업한 내용을 카테고리와 함께 설명해주세요
ex) - [UI 구현] 간결하게 작성
-->
-
## 설명
### 📌 기능
-
### 📌 UI
-
### 📌 Props
-
### 📌 사용하기
-
## 스크린샷
<!-- Responsive viewer 사용하여 PC, Tablet, Mobile 사이즈를 한 장으로 캡쳐해주세요 -->
### 🎥 모션 영상
### 📸 디바이스별 스크린샷
## 리뷰 요구사항
<!-- 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?
-->
-
PR 템플릿 사용 예시
제목 - Feat[#86]: 모집 예약 일정 UI 구현 및 예약 기능 구현
## 관련 문서
- issue: #86
- close #86
## 유형
-[x] UI 구현
-[x] 기능 구현
-[ ] 리팩토링
-[ ] 버그 해결
-[ ] 문서 업데이트
-[ ] 기타( )
## 작업 내용
- [기능 구현] 모집 상세페이지의 예약 기능을 구현했습니다.
- [UI 구현] 예약 캘린더 구현했습니다.
## 설명
### 📌 기능
- 예약 기능을 구현했습니다.
- 현재 설정된 연도와 월을 기준으로 API를 사용하여 예약 가능한 날짜를 조회합니다.
- 현재 날짜를 기준으로 과거 월의 선택은 제한됩니다.
- 최대 30일까지 예약이 가능하며, 이후 월 이동은 지원하지 않습니다.
### 📌 UI
- 예약 가능 현황판 UI 구현
- 더 이상 예약 가능하지 않을 때에 대한 안내 UI 구현
- 반응형 (PC: Panel / Tablet, Mobile: Page)
### 📌 Props
- ReservationPanel
👉 [activityId] 상세페이지의 id를 prop으로 받습니다.
- ConfirmScheduleButton
👉 [isPanelOpen] 예약하기 패널의 열고 닫힘 여부를 prop으로 받습니다.
### 📌 사용하기
<ReservationPanel isLoggedIn activityId={activityId} maxCount={maxCount} onClick={handlePanelToggleClick} />
<ConfirmScheduleButton isPanelOpen={isReservationPanelOpen} onClick={handlePanelToggleClick} />
## 스크린샷
<!-- Responsive viewer 사용하여 PC, Tablet, Mobile 사이즈를 한 장으로 캡쳐해주세요 -->
### 🎥 모션 영상
### 📸 디바이스별 스크린샷
## 리뷰 요구사항
<!-- 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?
-->
- tanstack query로 예약 가능 리스트 get 한 부분에서, 더 개선할 부분이 있을 지 봐주시면 감사하겠습니다.
- Features by pages : Landing
- Features by pages : List
- Features by pages : Post Detail
- Features by pages : Create Post
- Features by pages : Edit Post
- Features by pages : MyPage
- Features by pages : Account
- Features by pages : Signin
- Features by pages : Signup
- Code Convention
- Commit Convention
- File and Directory Convention
- Git Convention
- Issue Convention
- PR Convention