4. PR 작성하기(PR 템플릿)

[JINi0S]

1. PR Template

1) 제목 컨벤션

작업내용은 문장 형태로 주로 조건 + 변화의 방식으로 제목을 정합니다.
복잡한 변화라면 긴 제목을 사용하셔도 무방하며 동사원형으로 문장을 마칩니다.

[Label/#이슈번호] 작업 내용

예시
[Feat/#11] 프로필 화면에서 좋아요 상품 컴포넌트 헤더에 상품 개수를 표시
[Feat/#24] 좋아요 상품이 미노출 상태인 경우 좋아요를 취소할 수 있도록 구현

2) 내용 템플릿

📌 ## ✏️ 개요
close #닫을 이슈 번호
작업 배경 및 작업 내용을 간단히 적어주세요.

## 💻 작업 사항
작업 내용을 자세히 적어주세요.

## 📄 리뷰 노트
리뷰어가 봐주면 하는 내용을 적어주세요.

## 📱결과 화면(optional)
리뷰어의 이해를 위해 스크린샷을 추가해주세요. 

## 📚 ETC(optional)
변경한 로직에 대해 추가로 공유하고 싶은 내용이 있다면 작성해주세요.
개발을 하시면서 발견하신 새로운 점을 팀원들에게 공유해주세요.
해결되지 않은 문제가 있다면 팀원들이 확인하도록 적어주세요.

✔️ PR을 올리기 전 확인하고 지워주세요.
- [x] merge할 branch를 확인해주세요(develop/master) 
- [x] reviewers와 Assigness를 지정해주세요

3) 설정

• Reviewers
  본인을 제외한 구성원 1명을 지정합니다.

• Assigness
  본인으로 지정합니다. 같이 작업한 인원이 있다면 작업 인원을 모두 지정합니다.

• Labels
  아래의 라벨에 따라 해당되는 태그를 지정합니다.

  • 수정사항
    • 🗝️ Feat: 기능을 개발, 수정했다
    • 🎨 Design: 디자인을 수정했다
    • 🐛 Bug: 버그를 고쳤다
    • 🛠️ Ref: 리팩토링했다
    • 📄 Doc: 문서를 수정했다
    • ⚙️ Chore: 인프라 세팅, 잡일을 수행했다
  • 긴급여부
    • 🚨 Emergency: 빠르게 적용되어야 한다
  • 소요시간
    • 🌱 Simple: 변경이 크지 않아 리뷰가 오래 걸리지 않는다

4) 주의 사항

15분 내로 리뷰 가능한 PR을 작성합시다 !

• PR과 커밋은 최대한 작은 단위로 쪼개기
• 리뷰어가 빌드 성공여부/코딩컨벤션 확인하는데 시간을 쓰지 않도록 하기