05. Issue, PR 규칙

Issue

작업 시작하기 전, 팀원들이 어떤 작업을 하는지 서로 알 수 있도록 Issue 를 올립니다.

Issue 제목 작성

Issue 의 제목의 경우, 아래 Issue Prefix를 활용하여, 제목을 작성합니다.

예시 : feat: 좋아요 기능 추가

Issue Prefix

feat	기능 구현에 관련한 이슈
fix	버그 수정에 관련한 이슈
refactor	리팩토링에 관련한 이슈
design	CSS, 디자인에 관련한 이슈

Issue 내용 작성

• 개발 시작 날짜
• 목표 완료 날짜
• 작업 내용 : 작업할 내용에 대해 작성합니다.

PR 및 코드리뷰

기능 구현 이 후, 구현한 기능이 무엇인지, 구현 시에 이슈나 제안사항 등의 내용을 작성하여 PR을 올리고, PR에 APPROVE 가 2개 이상일 시, develop에 merge 합니다.

PR 제목

• PR 역시, Issue에서 사용한 prefix를 이용합니다.
• 관련 이슈 내용이 잘 드러날 수 있는 제목을 사용합니다.

예시 : feat: 모달을 열었을 때 바깥쪽 스크롤을 막는 기능 구현

PR 내용

• 이슈 번호 : 해당 PR과 관련된 이슈 번호를 링크합니다.
• 작업 내용(자세히) : 코드 리뷰를 하는 팀원을 위하여, 작업 내용을 최대한 자세히 적어주세요.
• 구현 날짜
• 어려웠던 점 : 구현 중 어려웠던 점, 발생한 버그, 제안 사항 등을 작성합니다.

진행 상황 공유

해당 사항들의 진행상황은 Notion 의 스크럼 보드에 기록합니다.